1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>Scan</title>
8  </head>
9  <body>
10<h1><CODE>nn::uds::CTR::Scan</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> Scan(
15     void * pBuffer,
16     size_t bufferSize,
17     u8 subId,
18     bit32 localId
19);
20</pre>
21    </div>
22<h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>out</td>
34<th>pBuffer</th>
35<td>Discovered network information storage location.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>bufferSize</th>
40<td>Buffer size. Estimate roughly 1KB per network.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>subId</th>
45<td>Communication mode ID. Can be freely set by the application. Specify <CODE>0xff</CODE> to search all sub IDs.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>localId</th>
50<td>The local communication ID. Specify the value generated by <a href="../../../nn/uds/CTR/CreateLocalCommunicationId.html"><CODE>CreateLocalCommunicationId</CODE></a>.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>ResultSuccess</CODE></th>
64<td>Succeeded in creating local communication, and the network information found in the buffer was stored.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultNotInitialized</CODE></th>
68<td>The library is not initialized. Execute the <CODE>nn::uds::Initialize</CODE> function.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultInvalidState</CODE></th>
72<td>Not in an executable state. Returned when executed in a state other than <CODE>STATE_DISCONNECTED</CODE>.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultOutOfRange</CODE></th>
76<td>The specified argument value was not in the valid range for the argument. It is possible it will succeed if you re-execute with an appropriate value for the argument.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultWirelessOff</CODE></th>
80<td>Transitioned to wireless OFF mode. Re-initialization is required.</td>
81        </tr>
82        <tr>
83<th>A value other than the above.</th>
84<td>Failed for reasons other than those given above.</td>
85        </tr>
86      </table> </div>
87<h2>Description</h2>
88    <div class="section">
89<p>Scans for nearby networks.</p><p>By default, this requires 330 ms to complete.</p><!-- write here --></div>
90<h2>Revision History</h2>
91    <div class="section">
92      <dl class="history">
93        <dt>2011/02/21</dt>
94<dd>Added a timing guideline to the Description.<br />
95        </dd>
96        <dt>2011/01/25</dt>
97<dd>Restricted function to automatically scan all channels. The previous function can still be used as is for backwards compatibility, but note that connectivity can be substantially impaired if only one channel has been scanned in a production version.
98        </dd>
99        <dt>2010/10/15</dt>
100<dd>Expanded the information on the return values. Revised the Description to make it easier to understand.<br />
101        </dd>
102        <dt>2010/06/14</dt>
103<dd>Initial version.<br />
104        </dd>
105      </dl>
106    </div>
107  <hr><p>CONFIDENTIAL</p></body>
108</html>
109