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>Initialize</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/dlp/Overview.html">dlp</a>::<a href="../../../../nn/dlp/CTR/Overview.html">CTR</a>::<a href="../../../../nn/dlp/CTR/FakeClient/Overview.html">FakeClient</a>::Initialize</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> Initialize(
15     <a href="../../../../nn_types/u8.html">u8</a> scanNum,
16     nn::Handle eventHandle,
17     void * pBuffer,
18     const size_t bufferSize
19);
20</pre>
21    </div>
22<h2>Parameters</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>scanNum</th>
35<td>Specifies the number of child programs that can be received by a single scan request. The maximum value is <CODE><a href="../../../../nn/dlp/CTR/MAX_SCAN_NUM.html">MAX_SCAN_NUM</a></CODE>.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>eventHandle</th>
40<td>Specifies a handle to the <CODE><a href="../../../../nn/os/Event/Overview.html">nn::os::Event</a></CODE> object waiting for a signal from Download Play. Initialize the event in the application. Use the <CODE><a href="../../../../nn/dlp/CTR/FakeClient/GetEventDesc.html">GetEventDesc</a></CODE> function to get the event information.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>pBuffer</th>
45<td>Pointer to the DLP working buffer. Must be 4096-byte aligned.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>bufferSize</th>
50<td>Size of working buffer. Must be 4096-byte aligned.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">The following <a href="../../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values 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><CODE>Result::IsSuccess</CODE></th>
64<td>Initialization successful.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultInvalidPointer</CODE></th>
68<td><SPAN class="argument">pBuffer</SPAN> is either NULL or not 4096-byte aligned.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultOutOfRange</CODE></th>
72<td>Either <SPAN class="argument">scanNum</SPAN> or <SPAN class="argument">bufferSize</SPAN> is invalid.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultInvalidHandle</CODE></th>
76<td><SPAN class="argument">eventHandle</SPAN> is invalid.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultAlreadyOccupiedWirelessDevice</CODE></th>
80<td>The wireless device is already occupied for another purpose. Exit the other wireless process.</td>
81        </tr>
82        <tr>
83<th><CODE>ResultWirelessOff</CODE></th>
84<td>Communication is impossible (the system is in Sleep Mode or wireless-disabled mode).</td>
85        </tr>
86        <tr>
87<th><CODE>ResultInternalError</CODE></th>
88<td>An irrecoverable error occurred internally.</td>
89        </tr>
90      </table> </div>
91<h2>Description</h2>
92    <div class="section">
93<p>Initializes a fake client.</p><p>For the <SPAN class="argument">pBuffer</SPAN> argument, specify a 4096-byte aligned buffer of the size specified by the <CODE><a href="../../../../nn/dlp/CTR/Server/GetBufferSize.html">GetBufferSize</a></CODE> function. Do not use device memory for the buffer. This function might block for a long time.  This can  happen because communications in the background have been completed and the DLP library has taken control of the communications device.<br />This control of the communications device will continue until the <CODE><a href="../../../../nn/dlp/CTR/FakeClient/Finalize.html">Finalize</a></CODE> function is called.</p><!-- write here --></div>
94<h2>Revision History</h2>
95    <div class="section">
96      <dl class="history">
97        <dt>2010/08/16</dt>
98<dd>Initial version.<br />
99        </dd>
100      </dl>
101    </div>
102  <hr><p>CONFIDENTIAL</p></body>
103</html>