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><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/dlp/Overview.html">dlp</a>::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> 57 Library that handles Download Play. For details on Download Play, see the Programming Manual. 58 </p><h2> Notes </h2><h3> Server Execution </h3><p> 59 When verifying operations, check a variety of server and client system versions. Operations related to system updates that occur through Download Play are guaranteed by the built-in application, <CODE>Dlplay</CODE>, and the DLP library. For this reason, you do not need to check the behavior of Download Play as it relates to system updates in your application. However, please check in your application that message display is turned on and off in accordance to the <SPAN class="argument">pNotice</SPAN> flag of the <CODE>Server::Initialize</CODE> function. To read about the <SPAN class="argument">pNotice</SPAN> flag, see the Function Reference for this function. 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/ResultInvalidDlpVersion/Overview.html"><CODE>nn::dlp::CTR::ResultInvalidDlpVersion</CODE></a> 131 </th> 132 <td>Differs from expected DLP protocol version.</td> 133 </tr> 134 <tr> 135 <th> 136 <a href="../../../nn/dlp/CTR/ResultIncommutable/Overview.html">nn::dlp::CTR::ResultIncommutable</a> 137 </th> 138 <td>Cannot communicate with the partner.</td> 139 </tr> 140 <tr> 141 <th> 142 <a href="../../../nn/dlp/CTR/ResultNoData/Overview.html">nn::dlp::CTR::ResultNoData</a> 143 </th> 144 <td>There is no target data.</td> 145 </tr> 146 <tr> 147 <th> 148 <a href="../../../nn/dlp/CTR/ResultWirelessOff/Overview.html">nn::dlp::CTR::ResultWirelessOff</a> 149 </th> 150 <td>State where communication is not possible.</td> 151 </tr> 152 <tr> 153 <th> 154 <a href="../../../nn/dlp/CTR/ResultNotFoundServer/Overview.html">nn::dlp::CTR::ResultNotFoundServer</a> 155 </th> 156 <td>Cannot find server.</td> 157 </tr> 158 <tr> 159 <th> 160 <a href="../../../nn/dlp/CTR/ResultServerIsFull/Overview.html">nn::dlp::CTR::ResultServerIsFull</a> 161 </th> 162 <td>No more clients can connect to the server.</td> 163 </tr> 164 <tr> 165 <th> 166 <a href="../../../nn/dlp/CTR/ResultDeniedFromServer/Overview.html">nn::dlp::CTR::ResultDeniedFromServer</a> 167 </th> 168 <td>The server refused the connection. Returned while server is distributing a child program.</td> 169 </tr> 170 <tr> 171 <th> 172 <a href="../../../nn/dlp/CTR/ResultConnectionTimeout/Overview.html">nn::dlp::CTR::ResultConnectionTimeout</a> 173 </th> 174 <td>The connection attempt timed out.</td> 175 </tr> 176 <tr> 177 <th class="category" colspan="2">Other</th> 178 </tr> 179 <tr> 180 <th> 181 <a href="../../../nn/dlp/CTR/FakeClient/Overview.html"><CODE>nn::dlp::CTR::FakeClient</CODE></a> 182 </th> 183 <td>Class for Download Play fake clients.</td> 184 </tr> 185 <tr> 186 <th> 187 <a href="../../../nn/dlp/CTR/FakeClientWithName/Overview.html"><CODE>nn::dlp::CTR::FakeClientWithName</CODE></a> 188 </th> 189 <td>Class for fake clients for Download Play.</td> 190 </tr> 191 <tr> 192 <th> 193 <a href="../../../nn/dlp/CTR/Server/Overview.html"><CODE>nn::dlp::CTR::Server</CODE></a> 194 </th> 195 <td>Class for Download Play servers.</td> 196 </tr> 197 <tr> 198 <th> 199 <a href="../../../nn/dlp/CTR/ServerWithName/Overview.html"><CODE>nn::dlp::CTR::ServerWithName</CODE></a> 200 </th> 201 <td>Class for servers for Download Play.</td> 202 </tr> </table> 203 </div> 204 </a> <a name="struct" id="struct"> 205 <h2>Structures</h2> 206 <div class="section"> 207 <table class="members"> 208 <tr> 209 <th> 210 <a href="../../../nn/dlp/CTR/ClientDiscoveredServer/Overview.html"><CODE>nn::dlp::CTR::ClientDiscoveredServer</CODE></a> 211 </th> 212 <td>Event information when the <CODE>EventDesc</CODE> type is <CODE>EVENT_TYPE_CLIENT_DISCOVERED_SERVER</CODE>.</td> 213 </tr> 214 <tr> 215 <th> 216 <a href="../../../nn/dlp/CTR/ClientDiscoveredTitle/Overview.html"><CODE>nn::dlp::CTR::ClientDiscoveredTitle</CODE></a> 217 </th> 218 <td>Event information when the <CODE>EventDesc</CODE> type is <CODE>EVENT_TYPE_CLIENT_DISCOVERED_TITLE</CODE>.</td> 219 </tr> 220 <tr> 221 <th> 222 <a href="../../../nn/dlp/CTR/ClientStateWaitingInvite/Overview.html"><CODE>nn::dlp::CTR::ClientStateWaitingInvite</CODE></a> 223 </th> 224 <td>Event information when the <CODE>EventDesc</CODE> type is <CODE>EVENT_TYPE_CLIENT_STATE_WAITING_INVITE</CODE>.</td> 225 </tr> 226 <tr> 227 <th> 228 <a href="../../../nn/dlp/CTR/EventDesc/Overview.html"><CODE>nn::dlp::CTR::EventDesc</CODE></a> 229 </th> 230 <td>Notification of an event occurring in DLP. The information changes depending on the <CODE>type</CODE> member.</td> 231 </tr> 232 <tr> 233 <th> 234 <a href="../../../nn/dlp/CTR/ClientStatus/Overview.html"><CODE>nn::dlp::CTR::ClientStatus</CODE></a> 235 </th> 236 <td>Client state and download progress.</td> 237 </tr> 238 <tr> 239 <th> 240 <a href="../../../nn/dlp/CTR/IconInfo/Overview.html"><CODE>nn::dlp::CTR::IconInfo</CODE></a> 241 </th> 242 <td>Icon information.</td> 243 </tr> 244 <tr> 245 <th> 246 <a href="../../../nn/dlp/CTR/TitleInfo/Overview.html"><CODE>nn::dlp::CTR::TitleInfo</CODE></a> 247 </th> 248 <td>Information on a child program.</td> 249 </tr> 250 <tr> 251 <th> 252 <a href="../../../nn/dlp/CTR/ServerInfo/Overview.html"><CODE>nn::dlp::CTR::ServerInfo</CODE></a> 253 </th> 254 <td>Server information.</td> 255 </tr> 256 <tr> 257 <th> 258 <a href="../../../nn/dlp/CTR/RebootInfo/Overview.html"><CODE>nn::dlp::CTR::RebootInfo</CODE></a> 259 </th> 260 <td>A structure that stores information used to reconnect to a parent device after a reboot.</td> 261 </tr> </table> 262 </div> 263 </a> <a name="enum" id="enum"> 264 <h2>Enumerated Types</h2> 265 <div class="section"> 266 <table class="members"> 267 <tr> 268 <td width="100"> </td> 269 <th> 270 <a href="../../../nn/dlp/CTR/ClientState.html"><CODE>ClientState</CODE></a> 271 </th> 272 <td>Client states.</td> 273 </tr> 274 <tr> 275 <td width="100"> </td> 276 <th> 277 <a href="../../../nn/dlp/CTR/ServerState.html"><CODE>ServerState</CODE></a> 278 </th> 279 <td>Server states.</td> 280 </tr> 281 <tr> 282 <td width="100"> </td> 283 <th> 284 <a href="../../../nn/dlp/CTR/EventType.html"><CODE>EventType</CODE></a> 285 </th> 286 <td>Types of notification events.</td> 287 </tr> </table> 288 </div> 289 </a> <a name="typedef" id="typedef"> 290 <h2><CODE>typedef</CODE> Definitions</h2> 291 <div class="section"> 292 <table class="members"> 293 <tr> 294 <td width="100" /> 295 <th> 296 <a href="../../../nn/dlp/CTR/NodeInfo.html"><CODE>NodeInfo</CODE></a> 297 </th> 298 <td>Node information.</td> 299 </tr> </table> 300 </div> 301 </a> <a name="constant" id="constant"> 302 <h2>Constants</h2> 303 <div class="section"> 304 <table class="members"> 305 <tr> 306 <th class="category" colspan="4">Size and Number Constants</th> 307 </tr> 308 <tr> 309 <td width="100"> </td> 310 <th> 311 <span class="argument"><a href="../../../nn/dlp/CTR/MAX_CHILD_IMPORT_SIZE.html">MAX_CHILD_IMPORT_SIZE</a></span> 312 </th> 313 <td width="100">const size_t</td> 314 <td>The maximum size of the child program.</td> 315 </tr> 316 <tr> 317 <td width="100"> </td> 318 <th> 319 <span class="argument"><a href="../../../nn/dlp/CTR/SHORT_TITLE_NAME_LENGTH.html"><CODE>SHORT_TITLE_NAME_LENGTH</CODE></a></span> 320 </th> 321 <td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 322 <td>The length (in characters) of a child program's one-line name (including the NULL terminator).</td> 323 </tr> 324 <tr> 325 <td width="100"> </td> 326 <th> 327 <span class="argument"><a href="../../../nn/dlp/CTR/LONG_TITLE_NAME_LENGTH.html"><CODE>LONG_TITLE_NAME_LENGTH</CODE></a></span> 328 </th> 329 <td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 330 <td>The length (in characters) of a child program's two-line name (including the NULL terminator).</td> 331 </tr> 332 <tr> 333 <td width="100"> </td> 334 <th> 335 <span class="argument"><a href="../../../nn/dlp/CTR/ICON_HEIGHT_PIXEL.html"><CODE>ICON_HEIGHT_PIXEL</CODE></a></span> 336 </th> 337 <td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 338 <td>Icon height in pixels.</td> 339 </tr> 340 <tr> 341 <td width="100"> </td> 342 <th> 343 <span class="argument"><a href="../../../nn/dlp/CTR/ICON_WIDTH_PIXEL.html"><CODE>ICON_WIDTH_PIXEL</CODE></a></span> 344 </th> 345 <td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 346 <td>Icon width in pixels.</td> 347 </tr> 348 <tr> 349 <td width="100"> </td> 350 <th> 351 <span class="argument"><a href="../../../nn/dlp/CTR/ICON_PIXEL_COUNT.html"><CODE>ICON_PIXEL_COUNT</CODE></a></span> 352 </th> 353 <td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 354 <td>The number of pixels in the icon.</td> 355 </tr> 356 <tr> 357 <td width="100"> </td> 358 <th> 359 <span class="argument"><a href="../../../nn/dlp/CTR/RATING_INFO_SIZE.html"><CODE>RATING_INFO_SIZE</CODE></a></span> 360 </th> 361 <td width="100">const <a href="../../../nn_types/s32.html">s32</a></td> 362 <td>Size of Parental Controls information/data.</td> 363 </tr> 364 <tr> 365 <td width="100"> </td> 366 <th> 367 <span class="argument"><a href="../../../nn/dlp/CTR/MAX_NODE_NUM.html"><CODE>MAX_NODE_NUM</CODE></a></span> 368 </th> 369 <td width="100">const <a href="../../../nn_types/u16.html">u16</a></td> 370 <td>Maximum number of nodes that can exist in a network, including servers.</td> 371 </tr> 372 <tr> 373 <td width="100"> </td> 374 <th> 375 <span class="argument"><a href="../../../nn/dlp/CTR/MAX_CLIENT_NUM.html"><CODE>MAX_CLIENT_NUM</CODE></a></span> 376 </th> 377 <td width="100">const <a href="../../../nn_types/u16.html">u16</a></td> 378 <td>Maximum number of clients that can connect to a server.</td> 379 </tr> 380 <tr> 381 <td width="100"> </td> 382 <th> 383 <span class="argument"><a href="../../../nn/dlp/CTR/MAX_SCAN_NUM.html"><CODE>MAX_SCAN_NUM</CODE></a></span> 384 </th> 385 <td width="100">const <a href="../../../nn_types/u8.html">u8</a></td> 386 <td>The maximum number of child programs that a client can scan at once.</td> 387 </tr> 388 <tr> 389 <td width="100"> </td> 390 <th> 391 <span class="argument"><a href="../../../nn/dlp/CTR/MIN_NETWORK_BLOCK_BUFFER_NUM.html">MIN_NETWORK_BLOCK_BUFFER_NUM</a></span> 392 </th> 393 <td width="100"><CODE>const size_t</CODE></td> 394 <td>Minimum number for the network block buffer.</td> 395 </tr> 396 <tr> 397 <td width="100"> </td> 398 <th> 399 <span class="argument"><a href="../../../nn/dlp/CTR/MAX_NETWORK_BLOCK_BUFFER_NUM.html">MAX_NETWORK_BLOCK_BUFFER_NUM</a></span> 400 </th> 401 <td width="100"><CODE>const size_t</CODE></td> 402 <td>Maximum number for the network block buffer.</td> 403 </tr> 404 <tr> 405 <td width="100"> </td> 406 <th> 407 <span class="argument"><a href="../../../nn/dlp/CTR/MIN_NETWORK_BLOCK_BUFFER_SIZE.html">MIN_NETWORK_BLOCK_BUFFER_SIZE</a></span> 408 </th> 409 <td width="100"><CODE>const size_t</CODE></td> 410 <td>Minimum size of the network block buffer.</td> 411 </tr> 412 <tr> 413 <td width="100"> </td> 414 <th> 415 <span class="argument"><a href="../../../nn/dlp/CTR/MAX_NETWORK_BLOCK_BUFFER_SIZE.html">MAX_NETWORK_BLOCK_BUFFER_SIZE</a></span> 416 </th> 417 <td width="100"><CODE>const size_t</CODE></td> 418 <td>Maximum size of the network block buffer.</td> 419 </tr> 420 <tr> 421 <td width="100"> </td> 422 <th> 423 <span class="argument"><a href="../../../nn/dlp/CTR/MAX_CHILD_UDS_PASSPHRASE_LENGTH.html">MAX_CHILD_UDS_PASSPHRASE_LENGTH</a></span> 424 </th> 425 <td width="100"><CODE>const size_t</CODE></td> 426 <td>Maximum length of the UDS passphrase when a child is reconnecting (including NULL termination).</td> 427 </tr> </table> 428 </div> 429 </a> <a name="function" id="function"> 430 <h2>Functions</h2> 431 <div class="section"> 432 <table class="members"> 433 <tr> 434 <th class="category" colspan="3">Definitions of Common Functions Used Throughout DLP</th> 435 </tr> 436 <tr> 437 <td width="100"> </td> 438 <th> 439 <a href="../../../nn/dlp/CTR/GetRebootInfo.html"><CODE>GetRebootInfo</CODE></a> 440 </th> 441 <td>Gets the reconnection information needed to connect to the network after rebooting.</td> 442 </tr> 443 <tr> 444 <td width="100"> </td> 445 <th> 446 <a href="../../../nn/dlp/CTR/IsChild.html"><CODE>IsChild</CODE></a> 447 </th> 448 <td>Determines whether the program that called this function is a child program.</td> 449 </tr> </table> 450 </div> 451 </a> 452 <h2>Revision History</h2> 453 <div class="section"> 454 <dl class="history"> 455 <dt>2012/07/04</dt> 456<dd>Because the server is never run as the download application, deleted the description of the execution format of media that the server can execute.<br /> 457 </dd> 458 <dt>2012/05/02</dt> 459 <dd>Added a caution about system updates.<br /> 460 </dd> 461 <dt>2012/04/26</dt> 462 <dd>Added a caution about running a server as a downloadable application.<br /> 463 </dd> 464 <dt>2012/04/13</dt> 465 <dd>Added condition for returning <CODE>ResultDeniedFromServer</CODE>.<br /> 466 </dd> 467 <dt>2011/04/25</dt> 468 <dd>Added the note that the server can only run as card application (CCI).<br /> 469 </dd> 470 <dt>2010/06/14</dt> 471 <dd>Initial version.<br /> 472 </dd> 473 </dl> 474 </div> 475 <hr><p>CONFIDENTIAL</p></body> 476</html>