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