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>StartScan</title>
8  </head>
9  <body>
10<h1><CODE>nn::dlp::CTR::FakeClient::StartScan</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nn/Result/Overview.html">nn::Result</a> StartScan(
15     bit16 channels,
16     u32 uniqueId = 0,
17     u8 childIndex = 0,
18     const u8 * pMac = NULL
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>in</td>
34<th>channels</th>
35<td>Specifies a bitmap of the channels to scan. Use the <CODE><a href="../../../../nn/dlp/CTR/FakeClient/GetChannels.html">GetChannels</a></CODE> function to get the scannable channels.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>uniqueId</th>
40<td>Specifies an Unique ID to narrow down scanning results. If <CODE>0</CODE> is specified, narrowing down is not used.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>childIndex</th>
45<td>Specifies a childIndex to narrow down scanning results. Invalid when the UniqueId is 0.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>pMac</th>
50<td>Specifies a server MAC address to narrow down scanning results. Specify <CODE>NULL</CODE> to not narrow down results using MAC addresses.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">The following <a href="../../../../nn/Result/Overview.html">Result</a>s are returned as the result of the operation.<br /> <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>ResultSuccess</th>
64<td>The scan started successfully.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultInvalidState</CODE></th>
68<td>The state is invalid. Use this with CLIENT_STATE_DISCONNECTED_NETWORK.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultOutOfRange</CODE></th>
72<td>The channels value is invalid.</td>
73        </tr>
74      </table> </div>
75<h2>Description</h2>
76    <div class="section">
77<p>Starts scanning for servers.</p><p>Scans after clearing out the preceding scanning results. Scanning continues until the <CODE><a href="../../../../nn/dlp/CTR/FakeClient/StopScan.html">StopScan</a></CODE> function is called. Use the <CODE><a href="../../../../nn/dlp/CTR/FakeClient/GetServerInfo.html">GetServerInfo</a></CODE> and <CODE>GetTitleInfo</CODE> functions to get scanning results while scanning.</p><!-- write here --></div>
78<h2>Revision History</h2>
79    <div class="section">
80      <dl class="history">
81        <dt>2010/08/16</dt>
82<dd>Initial version.<br />
83        </dd>
84      </dl>
85    </div>
86  <hr><p>CONFIDENTIAL</p></body>
87</html>