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     u8 channel = 0,
20     u16 scanTime = 0
21);
22</pre>
23    </div>
24<h2>Arguments</h2>
25    <div class="section">
26      <table class="arguments">
27        <thead>
28          <tr>
29            <td width="15" />
30<th>Name</th>
31<td>Description</td>
32          </tr>
33        </thead>
34        <tr>
35<td>out</td>
36<th>pBuffer</th>
37<td>Discovered network information storage location.</td>
38        </tr>
39        <tr>
40<td>in</td>
41<th>bufferSize</th>
42<td>Buffer size. Estimate roughly 1KB per network.</td>
43        </tr>
44        <tr>
45<td>in</td>
46<th>subId</th>
47<td>Communication mode ID. Can be freely set by the application. Specify <CODE>0xff</CODE> to search all sub IDs.</td>
48        </tr>
49        <tr>
50<td>in</td>
51<th>localId</th>
52<td>The local communication ID. Specify the value generated by <a href="../../../nn/uds/CTR/CreateLocalCommunicationId.html"><CODE>CreateLocalCommunicationId</CODE></a>.</td>
53        </tr>
54        <tr>
55<td>in</td>
56<th>channel</th>
57<td>Scans all channels used by UDS. Only set this value when you want to scan a specific channel.(0: Scans all channels used by UDS: 1, 6, and 11.)</td>
58        </tr>
59        <tr>
60<td>in</td>
61<th>scanTime</th>
62<td>The scan time for a single channel. There is normally no need to specify this. (0: 110 milliseconds)</td>
63        </tr> </table>
64    </div>
65<h2>Return Values</h2>
66<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 />
67      <table class="arguments">
68        <thead>
69          <tr>
70<th>Value</th>
71<td>Description</td>
72          </tr>
73        </thead>
74        <tr>
75<th><CODE>ResultSuccess</CODE></th>
76<td>Succeeded in creating local communication, and the network information found in the buffer was stored.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultNotInitialized</CODE></th>
80<td>The library is not initialized. Execute the <CODE>nn::uds::Initialize</CODE> function.</td>
81        </tr>
82        <tr>
83<th>ResultInvalidState</th>
84<td>Not in an executable state. Returned when executed in a state other than <CODE>STATE_DISCONNECTED</CODE>.</td>
85        </tr>
86        <tr>
87<th>ResultOutOfRange</th>
88<td>The specified argument was not in a specifiable range. It is possible it will succeed if you re-execute with an appropriate value for the argument.</td>
89        </tr>
90        <tr>
91<th>ResultWirelessOff</th>
92<td>Transitioned to wireless OFF mode. Re-initialization is required.</td>
93        </tr>
94        <tr>
95<th>A value other than the above.</th>
96<td>Failed for reasons other than those given above.</td>
97        </tr>
98      </table> </div>
99<h2>Description</h2>
100    <div class="section">
101<p>Scans for nearby networks.</p><!-- write here --></div>
102<h2>Revision History</h2>
103    <div class="section">
104      <dl class="history">
105        <dt>2010/10/15</dt>
106<dd>Expanded the information on the return values. Revised the Description to make it easier to understand.<br />
107        </dd>
108        <dt>2010/06/14</dt>
109<dd>Initial version.<br />
110        </dd>
111      </dl>
112    </div>
113  <hr><p>CONFIDENTIAL</p></body>
114</html>
115