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    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>nn::dlp::CTR</title>
51  </head>
52  <body>
53<h1><CODE>nn::dlp::CTR</CODE> Namespace</h1>
54<h2>Description</h2>
55    <div class="section">
56<p>The <a href="../../../nn/dlp/CTR/Overview.html">CTR</a> DLP (Download Play) namespace. <br />(This can also be written without the <CODE>::CTR</CODE> portion.)</p><p>
57This library is for Download Play. For details on Download Play, see the Programming Manuals.
58</p><h2> Notes</h2><h3> Server Execution </h3><p>
59The server can only run as card application (CCI). If you run the server as a downloadable application, the <CODE>Server::Initialize</CODE> function will return the error <B>ResultInvalidMediaType</B>.
60            </p></div>
61    <a name="class" id="class">
62<h2>Classes</h2>
63      <div class="section">
64        <table class="members">
65          <tr>
66<th class="category" colspan="2"><CODE>Result</CODE></th>
67          </tr>
68          <tr>
69            <th>
70<a href="../../../nn/dlp/CTR/ResultAlreadyOccupiedWirelessDevice/Overview.html">nn::dlp::CTR::ResultAlreadyOccupiedWirelessDevice</a>
71            </th>
72<td>The wireless device is already occupied.</td>
73          </tr>
74          <tr>
75            <th>
76<a href="../../../nn/dlp/CTR/ResultInvalidState/Overview.html">nn::dlp::CTR::ResultInvalidState</a>
77            </th>
78<td>The internal state is inappropriate for using the API.</td>
79          </tr>
80          <tr>
81            <th>
82<a href="../../../nn/dlp/CTR/ResultOutOfRange/Overview.html">nn::dlp::CTR::ResultOutOfRange</a>
83            </th>
84<td>The parameter used is out of range.</td>
85          </tr>
86          <tr>
87            <th>
88<a href="../../../nn/dlp/CTR/ResultInvalidPointer/Overview.html">nn::dlp::CTR::ResultInvalidPointer</a>
89            </th>
90<td>The pointer argument is invalid.</td>
91          </tr>
92          <tr>
93            <th>
94<a href="../../../nn/dlp/CTR/ResultInvalidHandle/Overview.html">nn::dlp::CTR::ResultInvalidHandle</a>
95            </th>
96<td>The handle argument is invalid.</td>
97          </tr>
98          <tr>
99            <th>
100<a href="../../../nn/dlp/CTR/ResultInternalError/Overview.html">nn::dlp::CTR::ResultInternalError</a>
101            </th>
102<td>An error occurred that cannot be handled from the application.</td>
103          </tr>
104          <tr>
105            <th>
106<a href="../../../nn/dlp/CTR/ResultInvalidMediaType/Overview.html">nn::dlp::CTR::ResultInvalidMediaType</a>
107            </th>
108<td>The media to be accessed is not supported.</td>
109          </tr>
110          <tr>
111            <th>
112<a href="../../../nn/dlp/CTR/ResultFailedToAccessMedia/Overview.html">nn::dlp::CTR::ResultFailedToAccessMedia</a>
113            </th>
114<td>Access to media failed.</td>
115          </tr>
116          <tr>
117            <th>
118<a href="../../../nn/dlp/CTR/ResultChildTooLarge/Overview.html">nn::dlp::CTR::ResultChildTooLarge</a>
119            </th>
120<td>Too much NAND memory is required to import the child program.</td>
121          </tr>
122          <tr>
123            <th>
124<a href="../../../nn/dlp/CTR/ResultInvalidRegion/Overview.html">nn::dlp::CTR::ResultInvalidRegion</a>
125            </th>
126<td>The child program has a different region than the parent.</td>
127          </tr>
128          <tr>
129            <th>
130<a href="../../../nn/dlp/CTR/ResultIncommutable/Overview.html">nn::dlp::CTR::ResultIncommutable</a>
131            </th>
132<td>Cannot communicate with the partner.</td>
133          </tr>
134          <tr>
135            <th>
136<a href="../../../nn/dlp/CTR/ResultNoData/Overview.html">nn::dlp::CTR::ResultNoData</a>
137            </th>
138<td>There is no target data.</td>
139          </tr>
140          <tr>
141            <th>
142<a href="../../../nn/dlp/CTR/ResultWirelessOff/Overview.html">nn::dlp::CTR::ResultWirelessOff</a>
143            </th>
144<td>State where communication is not possible.</td>
145          </tr>
146          <tr>
147            <th>
148<a href="../../../nn/dlp/CTR/ResultNotFoundServer/Overview.html">nn::dlp::CTR::ResultNotFoundServer</a>
149            </th>
150<td>Cannot find server.</td>
151          </tr>
152          <tr>
153            <th>
154<a href="../../../nn/dlp/CTR/ResultServerIsFull/Overview.html">nn::dlp::CTR::ResultServerIsFull</a>
155            </th>
156<td>No more clients can connect to the server.</td>
157          </tr>
158          <tr>
159            <th>
160<a href="../../../nn/dlp/CTR/ResultDeniedFromServer/Overview.html">nn::dlp::CTR::ResultDeniedFromServer</a>
161            </th>
162<td>The connection was also denied by the server.</td>
163          </tr>
164          <tr>
165            <th>
166<a href="../../../nn/dlp/CTR/ResultConnectionTimeout/Overview.html">nn::dlp::CTR::ResultConnectionTimeout</a>
167            </th>
168<td>The connection attempt timed out.</td>
169          </tr>
170          <tr>
171<th class="category" colspan="2">Other</th>
172          </tr>
173          <tr>
174            <th>
175<a href="../../../nn/dlp/CTR/FakeClient/Overview.html"><CODE>nn::dlp::CTR::FakeClient</CODE></a>
176            </th>
177<td>Class for Download Play fake clients.</td>
178          </tr>
179          <tr>
180            <th>
181<a href="../../../nn/dlp/CTR/Server/Overview.html"><CODE>nn::dlp::CTR::Server</CODE></a>
182            </th>
183<td>Class for Download Play servers.</td>
184          </tr> </table>
185      </div>
186    </a> <a name="struct" id="struct">
187<h2>Structures</h2>
188      <div class="section">
189        <table class="members">
190          <tr>
191            <th>
192<a href="../../../nn/dlp/CTR/ClientDiscoveredServer/Overview.html"><CODE>nn::dlp::CTR::ClientDiscoveredServer</CODE></a>
193            </th>
194<td>Event information when the <CODE>EventDesc</CODE> type is <CODE>EVENT_TYPE_CLIENT_DISCOVERED_SERVER</CODE>.</td>
195          </tr>
196          <tr>
197            <th>
198<a href="../../../nn/dlp/CTR/ClientDiscoveredTitle/Overview.html"><CODE>nn::dlp::CTR::ClientDiscoveredTitle</CODE></a>
199            </th>
200<td>Event information when the <CODE>EventDesc</CODE> type is <CODE>EVENT_TYPE_CLIENT_DISCOVERED_TITLE</CODE>.</td>
201          </tr>
202          <tr>
203            <th>
204<a href="../../../nn/dlp/CTR/ClientStateWaitingInvite/Overview.html"><CODE>nn::dlp::CTR::ClientStateWaitingInvite</CODE></a>
205            </th>
206<td>Event information when the <CODE>EventDesc</CODE> type is <CODE>EVENT_TYPE_CLIENT_STATE_WAITING_INVITE</CODE>.</td>
207          </tr>
208          <tr>
209            <th>
210<a href="../../../nn/dlp/CTR/EventDesc/Overview.html"><CODE>nn::dlp::CTR::EventDesc</CODE></a>
211            </th>
212<td>Notification of an event occurring in DLP. The information changes depending on the <CODE>type</CODE> member.</td>
213          </tr>
214          <tr>
215            <th>
216<a href="../../../nn/dlp/CTR/ClientStatus/Overview.html"><CODE>nn::dlp::CTR::ClientStatus</CODE></a>
217            </th>
218<td>Client state and download progress.</td>
219          </tr>
220          <tr>
221            <th>
222<a href="../../../nn/dlp/CTR/IconInfo/Overview.html"><CODE>nn::dlp::CTR::IconInfo</CODE></a>
223            </th>
224<td>Icon information.</td>
225          </tr>
226          <tr>
227            <th>
228<a href="../../../nn/dlp/CTR/TitleInfo/Overview.html"><CODE>nn::dlp::CTR::TitleInfo</CODE></a>
229            </th>
230<td>Information on a child program.</td>
231          </tr>
232          <tr>
233            <th>
234<a href="../../../nn/dlp/CTR/ServerInfo/Overview.html"><CODE>nn::dlp::CTR::ServerInfo</CODE></a>
235            </th>
236<td>Server information.</td>
237          </tr>
238          <tr>
239            <th>
240<a href="../../../nn/dlp/CTR/RebootInfo/Overview.html"><CODE>nn::dlp::CTR::RebootInfo</CODE></a>
241            </th>
242<td>A structure that stores information used to reconnect to a parent device after a reboot.</td>
243          </tr> </table>
244      </div>
245    </a> <a name="enum" id="enum">
246<h2>Enumerated Types</h2>
247      <div class="section">
248        <table class="members">
249          <tr>
250            <td width="100"> </td>
251            <th>
252<a href="../../../nn/dlp/CTR/ClientState.html"><CODE>ClientState</CODE></a>
253            </th>
254<td>Client states.</td>
255          </tr>
256          <tr>
257            <td width="100"> </td>
258            <th>
259<a href="../../../nn/dlp/CTR/ServerState.html"><CODE>ServerState</CODE></a>
260            </th>
261<td>Server states.</td>
262          </tr>
263          <tr>
264            <td width="100"> </td>
265            <th>
266<a href="../../../nn/dlp/CTR/EventType.html"><CODE>EventType</CODE></a>
267            </th>
268<td>Types of notification events.</td>
269          </tr> </table>
270      </div>
271    </a> <a name="typedef" id="typedef">
272<h2><CODE>typedef</CODE> Definitions</h2>
273      <div class="section">
274        <table class="members">
275          <tr>
276            <td width="100" />
277            <th>
278<a href="../../../nn/dlp/CTR/NodeInfo.html"><CODE>NodeInfo</CODE></a>
279            </th>
280<td>Node information.</td>
281          </tr> </table>
282      </div>
283    </a> <a name="constant" id="constant">
284<h2>Constants</h2>
285      <div class="section">
286        <table class="members">
287          <tr>
288<th class="category" colspan="3">Size and Number Constants</th>
289          </tr>
290          <tr>
291            <td width="100"> </td>
292            <th>
293<span class="argument"><a href="../../../nn/dlp/CTR/MAX_CHILD_IMPORT_SIZE.html">MAX_CHILD_IMPORT_SIZE</a></span>
294            </th>
295<td>The maximum size of the child program.</td>
296          </tr>
297          <tr>
298            <td width="100"> </td>
299            <th>
300<span class="argument"><a href="../../../nn/dlp/CTR/SHORT_TITLE_NAME_LENGTH.html"><CODE>SHORT_TITLE_NAME_LENGTH</CODE></a></span>
301            </th>
302<td>The length (in characters) of a child program's one-line name (including the NULL terminator).</td>
303          </tr>
304          <tr>
305            <td width="100"> </td>
306            <th>
307<span class="argument"><a href="../../../nn/dlp/CTR/LONG_TITLE_NAME_LENGTH.html"><CODE>LONG_TITLE_NAME_LENGTH</CODE></a></span>
308            </th>
309<td>The length (in characters) of a child program's two-line name (including the NULL terminator).</td>
310          </tr>
311          <tr>
312            <td width="100"> </td>
313            <th>
314<span class="argument"><a href="../../../nn/dlp/CTR/ICON_HEIGHT_PIXEL.html"><CODE>ICON_HEIGHT_PIXEL</CODE></a></span>
315            </th>
316<td>Icon height in pixels.</td>
317          </tr>
318          <tr>
319            <td width="100"> </td>
320            <th>
321<span class="argument"><a href="../../../nn/dlp/CTR/ICON_WIDTH_PIXEL.html"><CODE>ICON_WIDTH_PIXEL</CODE></a></span>
322            </th>
323<td>Icon width in pixels.</td>
324          </tr>
325          <tr>
326            <td width="100"> </td>
327            <th>
328<span class="argument"><a href="../../../nn/dlp/CTR/ICON_PIXEL_COUNT.html"><CODE>ICON_PIXEL_COUNT</CODE></a></span>
329            </th>
330<td>The number of pixels in the icon.</td>
331          </tr>
332          <tr>
333            <td width="100"> </td>
334            <th>
335<span class="argument"><a href="../../../nn/dlp/CTR/RATING_INFO_SIZE.html"><CODE>RATING_INFO_SIZE</CODE></a></span>
336            </th>
337<td>Size of Parental Controls information/data.</td>
338          </tr>
339          <tr>
340            <td width="100"> </td>
341            <th>
342<span class="argument"><a href="../../../nn/dlp/CTR/MAX_NODE_NUM.html"><CODE>MAX_NODE_NUM</CODE></a></span>
343            </th>
344<td>Maximum number of nodes that can exist in a network, including servers.</td>
345          </tr>
346          <tr>
347            <td width="100"> </td>
348            <th>
349<span class="argument"><a href="../../../nn/dlp/CTR/MAX_CLIENT_NUM.html"><CODE>MAX_CLIENT_NUM</CODE></a></span>
350            </th>
351<td>Maximum number of clients that can connect to a server.</td>
352          </tr>
353          <tr>
354            <td width="100"> </td>
355            <th>
356<span class="argument"><a href="../../../nn/dlp/CTR/MAX_SCAN_NUM.html"><CODE>MAX_SCAN_NUM</CODE></a></span>
357            </th>
358<td>The maximum number of child programs that a client can scan at once.</td>
359          </tr>
360          <tr>
361            <td width="100"> </td>
362            <th>
363<span class="argument"><a href="../../../nn/dlp/CTR/MIN_NETWORK_BLOCK_BUFFER_NUM.html">MIN_NETWORK_BLOCK_BUFFER_NUM</a></span>
364            </th>
365<td>Minimum number for the network block buffer.</td>
366          </tr>
367          <tr>
368            <td width="100"> </td>
369            <th>
370<span class="argument"><a href="../../../nn/dlp/CTR/MAX_NETWORK_BLOCK_BUFFER_NUM.html">MAX_NETWORK_BLOCK_BUFFER_NUM</a></span>
371            </th>
372<td>Maximum number for the network block buffer.</td>
373          </tr>
374          <tr>
375            <td width="100"> </td>
376            <th>
377<span class="argument"><a href="../../../nn/dlp/CTR/MIN_NETWORK_BLOCK_BUFFER_SIZE.html">MIN_NETWORK_BLOCK_BUFFER_SIZE</a></span>
378            </th>
379<td>Minimum size of the network block buffer.</td>
380          </tr>
381          <tr>
382            <td width="100"> </td>
383            <th>
384<span class="argument"><a href="../../../nn/dlp/CTR/MAX_NETWORK_BLOCK_BUFFER_SIZE.html">MAX_NETWORK_BLOCK_BUFFER_SIZE</a></span>
385            </th>
386<td>Maximum size of the network block buffer.</td>
387          </tr>
388          <tr>
389            <td width="100"> </td>
390            <th>
391<span class="argument"><a href="../../../nn/dlp/CTR/MAX_CHILD_UDS_PASSPHRASE_LENGTH.html">MAX_CHILD_UDS_PASSPHRASE_LENGTH</a></span>
392            </th>
393<td>Maximum length of the UDS passphrase when a child is reconnecting (including NULL termination).</td>
394          </tr> </table>
395      </div>
396    </a> <a name="function" id="function">
397<h2>Functions</h2>
398      <div class="section">
399        <table class="members">
400          <tr>
401<th class="category" colspan="3">Definitions of Common Functions Used Throughout DLP</th>
402          </tr>
403          <tr>
404            <td width="100">  </td>
405            <th>
406<a href="../../../nn/dlp/CTR/GetRebootInfo.html"><CODE>GetRebootInfo</CODE></a>
407            </th>
408<td>Gets the reconnection information needed to connect to the network after rebooting.</td>
409          </tr>
410          <tr>
411            <td width="100">  </td>
412            <th>
413<a href="../../../nn/dlp/CTR/IsChild.html"><CODE>IsChild</CODE></a>
414            </th>
415<td>Determines whether the program that called this function is a child program.</td>
416          </tr> </table>
417      </div>
418    </a>
419<h2>Revision History</h2>
420    <div class="section">
421      <dl class="history">
422        <dt>2011/04/25</dt>
423<dd>Added the note that the server can only run as card application (CCI).<br />
424        </dd>
425        <dt>2010/06/14</dt>
426<dd>Initial version.<br />
427        </dd>
428      </dl>
429    </div>
430  <hr><p>CONFIDENTIAL</p></body>
431</html>