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::boss</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../nn/Overview.html">nn</a>::boss</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>Namespace for the BOSS API.</p><p> 57SpotPass is a general term for BOSS （Background Online Service System） communication functions.<br />Applications can use BOSS to communicate in the background with data servers provided by Nintendo ("BOSS data servers"). Although data downloading is the only communication feature that is currently supported, support for data uploading is planned.<br />To use BOSS, an application must register a task (a set of information specific to the communication process) in BOSS, and then start the task. The task configuration includes such information as the execution interval and the number of executions remaining. BOSS executes the task periodically in the background, based on this information.<br />The application can learn when a task finishes downloading new data by polling the state of the task or event notifications. This data can also be read via BOSS. The following tasks are currently provided.<br />- Nintendo archive download task (NADL task)<br /> This task is essentially run in the background, but once a task has been registered, the application can run it whenever it likes. In this case, the task's communication process will be run in the foreground.<br /></p><p><B>Note:</B> As of CTR-SDK 2.1, BOSS tasks will not operate on CTR systems that have no country settings. Configure your hardware with country settings if you will be doing BOSS development. You can configure the country setting using the initial startup sequence on the HOME Menu.<br /></p></div> 58 <a name="class" id="class"> 59<h2>Classes</h2> 60 <div class="section"> 61 <table class="members"> 62 <tr> 63<th class="category" colspan="2"><CODE>Result</CODE></th> 64 </tr> 65 <tr> 66 <th> 67<a href="../../nn/boss/ResultInvalidPolicy/Overview.html"><CODE>nn::boss::ResultInvalidPolicy</CODE></a> 68 </th> 69<td>The policy information pointer is <CODE>NULL</CODE>.</td> 70 </tr> 71 <tr> 72 <th> 73<a href="../../nn/boss/ResultInvalidAction/Overview.html"><CODE>nn::boss::ResultInvalidAction</CODE></a> 74 </th> 75<td>The task action pointer is <CODE>NULL</CODE>.</td> 76 </tr> 77 <tr> 78 <th> 79<a href="../../nn/boss/ResultInvalidOption/Overview.html"><CODE>nn::boss::ResultInvalidOption</CODE></a> 80 </th> 81<td>The task option pointer is <CODE>NULL</CODE>, or the option code is invalid.</td> 82 </tr> 83 <tr> 84 <th> 85<a href="../../nn/boss/ResultInvalidAppIdList/Overview.html"><CODE>nn::boss::ResultInvalidAppIdList</CODE></a> 86 </th> 87<td>The pointer for getting the application list is <CODE>NULL</CODE>.</td> 88 </tr> 89 <tr> 90 <th> 91<a href="../../nn/boss/ResultInvalidTaskIdList/Overview.html"><CODE>nn::boss::ResultInvalidTaskIdList</CODE></a> 92 </th> 93<td>The pointer for getting the task ID list is <CODE>NULL</CODE>.</td> 94 </tr> 95 <tr> 96 <th> 97<a href="../../nn/boss/ResultInvalidStepIdList/Overview.html"><CODE>nn::boss::ResultInvalidStepIdList</CODE></a> 98 </th> 99<td>The pointer for getting the step ID list is <CODE>NULL</CODE>.</td> 100 </tr> 101 <tr> 102 <th> 103<a href="../../nn/boss/ResultInvalidNsDataIdList/Overview.html"><CODE>nn::boss::ResultInvalidNsDataIdList</CODE></a> 104 </th> 105<td>The pointer to NS data list information is <CODE>NULL</CODE>.</td> 106 </tr> 107 <tr> 108 <th> 109<a href="../../nn/boss/ResultInvalidTaskStatus/Overview.html"><CODE>nn::boss::ResultInvalidTaskStatus</CODE></a> 110 </th> 111<td>The task status pointer is <CODE>NULL</CODE>.</td> 112 </tr> 113 <tr> 114 <th> 115<a href="../../nn/boss/ResultInvalidPropertyValue/Overview.html"><CODE>nn::boss::ResultInvalidPropertyValue</CODE></a> 116 </th> 117<td>The property value pointer is <CODE>NULL</CODE>.</td> 118 </tr> 119 <tr> 120 <th> 121<a href="../../nn/boss/ResultInvalidNewArrivalEvent/Overview.html"><CODE>nn::boss::ResultInvalidNewArrivalEvent</CODE></a> 122 </th> 123<td>The pointer to the new arrival event is <CODE>NULL</CODE>.</td> 124 </tr> 125 <tr> 126 <th> 127<a href="../../nn/boss/ResultInvalidNewArrivalFlag/Overview.html"><CODE>nn::boss::ResultInvalidNewArrivalFlag</CODE></a> 128 </th> 129<td>The pointer to the new arrival flag is <CODE>NULL</CODE>.</td> 130 </tr> 131 <tr> 132 <th> 133<a href="../../nn/boss/ResultInvalidOptoutFlag/Overview.html"><CODE>nn::boss::ResultInvalidOptoutFlag</CODE></a> 134 </th> 135<td>The pointer to the OPTOUT flag is <CODE>NULL</CODE>.</td> 136 </tr> 137 <tr> 138 <th> 139<a href="../../nn/boss/ResultInvalidTaskError/Overview.html"><CODE>nn::boss::ResultInvalidTaskError</CODE></a> 140 </th> 141<td>The pointer to the task error information is <CODE>NULL</CODE>.</td> 142 </tr> 143 <tr> 144 <th> 145<a href="../../nn/boss/ResultInvalidNsDataValue/Overview.html"><CODE>nn::boss::ResultInvalidNsDataValue</CODE></a> 146 </th> 147<td>The pointer to the region that stores NSDATA is <CODE>NULL</CODE>.</td> 148 </tr> 149 <tr> 150 <th> 151<a href="../../nn/boss/ResultInvalidNsDataInfo/Overview.html"><CODE>nn::boss::ResultInvalidNsDataInfo</CODE></a> 152 </th> 153<td>The pointer to the location that stores additional NSDATA information is <CODE>NULL</CODE>.</td> 154 </tr> 155 <tr> 156 <th> 157<a href="../../nn/boss/ResultInvalidNsDataReadFlag/Overview.html"><CODE>nn::boss::ResultInvalidNsDataReadFlag</CODE></a> 158 </th> 159<td>The pointer to the storage region for the NSDATA read flag is <CODE>NULL</CODE>.</td> 160 </tr> 161 <tr> 162 <th> 163<a href="../../nn/boss/ResultInvalidNsDataTime/Overview.html"><CODE>nn::boss::ResultInvalidNsDataTime</CODE></a> 164 </th> 165<td>The pointer to the region used to store the NSDATA update time is <CODE>NULL</CODE>.</td> 166 </tr> 167 <tr> 168 <th> 169<a href="../../nn/boss/ResultInvalidNextExecuteTime/Overview.html"><CODE>nn::boss::ResultInvalidNextExecuteTime</CODE></a> 170 </th> 171<td>The pointer to the location used to store the minutes value of the next execution time is <CODE>NULL</CODE>.</td> 172 </tr> 173 <tr> 174 <th> 175<a href="../../nn/boss/ResultHttpRequestHeaderPointerNull/Overview.html"><CODE>nn::boss::ResultHttpRequestHeaderPointerNull</CODE></a> 176 </th> 177<td>The HTTP request header pointer is <CODE>NULL</CODE>.</td> 178 </tr> 179 <tr> 180 <th> 181<a href="../../nn/boss/ResultInvalidPolicyListAvailability/Overview.html"><CODE>nn::boss::ResultInvalidPolicyListAvailability</CODE></a> 182 </th> 183<td>The pointer to information that can be used by the policy list is <CODE>NULL</CODE>.</td> 184 </tr> 185 <tr> 186 <th> 187<a href="../../nn/boss/ResultInvalidTestModeAvailability/Overview.html"><CODE>nn::boss::ResultInvalidTestModeAvailability</CODE></a> 188 </th> 189<td>The pointer to information usable in test mode is <CODE>NULL</CODE>.</td> 190 </tr> 191 <tr> 192 <th> 193<a href="../../nn/boss/ResultInvalidConfigParentalControl/Overview.html"><CODE>nn::boss::ResultInvalidConfigParentalControl</CODE></a> 194 </th> 195<td>The pointer to information on Parental Controls settings is <CODE>NULL</CODE>.</td> 196 </tr> 197 <tr> 198 <th> 199<a href="../../nn/boss/ResultInvalidConfigEulaAgreement/Overview.html"><CODE>nn::boss::ResultInvalidConfigEulaAgreement</CODE></a> 200 </th> 201<td>The pointer to information about whether the user has agreed to the EULA is <CODE>NULL</CODE>.</td> 202 </tr> 203 <tr> 204 <th> 205<a href="../../nn/boss/ResultInvalidPolicyListEnvId/Overview.html"><CODE>nn::boss::ResultInvalidPolicyListEnvId</CODE></a> 206 </th> 207<td>The pointer to the policy list's environment ID is <CODE>NULL</CODE>.</td> 208 </tr> 209 <tr> 210 <th> 211<a href="../../nn/boss/ResultInvalidPolicyListUrl/Overview.html"><CODE>nn::boss::ResultInvalidPolicyListUrl</CODE></a> 212 </th> 213<td>The pointer to the policy list's URL information is <CODE>NULL</CODE>.</td> 214 </tr> 215 <tr> 216 <th> 217<a href="../../nn/boss/ResultInvalidTaskId/Overview.html"><CODE>nn::boss::ResultInvalidTaskId</CODE></a> 218 </th> 219<td>The task ID pointer is <CODE>NULL</CODE> or a zero-length string.</td> 220 </tr> 221 <tr> 222 <th> 223<a href="../../nn/boss/ResultInvalidTaskStep/Overview.html"><CODE>nn::boss::ResultInvalidTaskStep</CODE></a> 224 </th> 225<td>The current step ID was specified during task registration.</td> 226 </tr> 227 <tr> 228 <th> 229<a href="../../nn/boss/ResultInvalidPropertyType/Overview.html"><CODE>nn::boss::ResultInvalidPropertyType</CODE></a> 230 </th> 231<td>The property type is not supported.</td> 232 </tr> 233 <tr> 234 <th> 235<a href="../../nn/boss/ResultInvalidUrl/Overview.html"><CODE>nn::boss::ResultInvalidUrl</CODE></a> 236 </th> 237<td>The URL string pointer is <CODE>NULL</CODE> or a zero-length string.</td> 238 </tr> 239 <tr> 240 <th> 241<a href="../../nn/boss/ResultInvalidFilePath/Overview.html"><CODE>nn::boss::ResultInvalidFilePath</CODE></a> 242 </th> 243<td>The file path string pointer is <CODE>NULL</CODE> or a zero-length string.</td> 244 </tr> 245 <tr> 246 <th> 247<a href="../../nn/boss/ResultInvalidTaskPriority/Overview.html"><CODE>nn::boss::ResultInvalidTaskPriority</CODE></a> 248 </th> 249<td>The specified task priority is invalid.</td> 250 </tr> 251 <tr> 252 <th> 253<a href="../../nn/boss/ResultInvalidTaskTargetDuration/Overview.html"><CODE>nn::boss::ResultInvalidTaskTargetDuration</CODE></a> 254 </th> 255<td>The task duration is invalid.</td> 256 </tr> 257 <tr> 258 <th> 259<a href="../../nn/boss/ResultActionCodeOutOfRange/Overview.html"><CODE>nn::boss::ResultActionCodeOutOfRange</CODE></a> 260 </th> 261<td>The task action code is invalid.</td> 262 </tr> 263 <tr> 264 <th> 265<a href="../../nn/boss/ResultInvalidNsDataSeekPosition/Overview.html"><CODE>nn::boss::ResultInvalidNsDataSeekPosition</CODE></a> 266 </th> 267<td>The NS data seek position exceeds the data size.</td> 268 </tr> 269 <tr> 270 <th> 271<a href="../../nn/boss/ResultInvalidMaxHttpRequestHeader/Overview.html"><CODE>nn::boss::ResultInvalidMaxHttpRequestHeader</CODE></a> 272 </th> 273<td>The number of registered HTTP request headers exceeds the maximum.</td> 274 </tr> 275 <tr> 276 <th> 277<a href="../../nn/boss/ResultInvalidMaxClientCert/Overview.html"><CODE>nn::boss::ResultInvalidMaxClientCert</CODE></a> 278 </th> 279<td>The number of client certificates set exceeds the maximum.</td> 280 </tr> 281 <tr> 282 <th> 283<a href="../../nn/boss/ResultInvalidMaxRootCa/Overview.html"><CODE>nn::boss::ResultInvalidMaxRootCa</CODE></a> 284 </th> 285<td>The number of root CAs exceeds the maximum that can be set.</td> 286 </tr> 287 <tr> 288 <th> 289<a href="../../nn/boss/ResultSchedulingPolicyOutOfRange/Overview.html"><CODE>nn::boss::ResultSchedulingPolicyOutOfRange</CODE></a> 290 </th> 291<td>The scheduling policy is invalid.</td> 292 </tr> 293 <tr> 294 <th> 295<a href="../../nn/boss/ResultApInfoTypeOutOfRange/Overview.html"><CODE>nn::boss::ResultApInfoTypeOutOfRange</CODE></a> 296 </th> 297<td>The AP information type is invalid.</td> 298 </tr> 299 <tr> 300 <th> 301<a href="../../nn/boss/ResultTaskPermissionOutOfRange/Overview.html"><CODE>nn::boss::ResultTaskPermissionOutOfRange</CODE></a> 302 </th> 303<td>The task permission information is invalid.</td> 304 </tr> 305 <tr> 306 <th> 307<a href="../../nn/boss/ResultWaitFinishTimeout/Overview.html"><CODE>nn::boss::ResultWaitFinishTimeout</CODE></a> 308 </th> 309<td>The <CODE>WAITFINISH</CODE> timeout.</td> 310 </tr> 311 <tr> 312 <th> 313<a href="../../nn/boss/ResultWaitFinishTaskNotDone/Overview.html"><CODE>nn::boss::ResultWaitFinishTaskNotDone</CODE></a> 314 </th> 315<td>The <CODE>WAITFINISH</CODE> task completed in a state other than <CODE>DONE</CODE>.</td> 316 </tr> 317 <tr> 318 <th> 319<a href="../../nn/boss/ResultIpcNotSessionInitialized/Overview.html"><CODE>nn::boss::ResultIpcNotSessionInitialized</CODE></a> 320 </th> 321<td>The IPC session is not initialized.</td> 322 </tr> 323 <tr> 324 <th> 325<a href="../../nn/boss/ResultIpcPropertySizeError/Overview.html"><CODE>nn::boss::ResultIpcPropertySizeError</CODE></a> 326 </th> 327<td>IPC property size error.</td> 328 </tr> 329 <tr> 330 <th> 331<a href="../../nn/boss/ResultIpcTooManyRequests/Overview.html"><CODE>nn::boss::ResultIpcTooManyRequests</CODE></a> 332 </th> 333<td>Too many IPC requests.</td> 334 </tr> 335 <tr> 336 <th> 337<a href="../../nn/boss/ResultAlreadyInitialized/Overview.html"><CODE>nn::boss::ResultAlreadyInitialized</CODE></a> 338 </th> 339<td>Initialization complete.</td> 340 </tr> 341 <tr> 342 <th> 343<a href="../../nn/boss/ResultOutOfMemory/Overview.html"><CODE>nn::boss::ResultOutOfMemory</CODE></a> 344 </th> 345<td>Insufficient memory.</td> 346 </tr> 347 <tr> 348 <th> 349<a href="../../nn/boss/ResultInvalidNumberOfNsd/Overview.html"><CODE>nn::boss::ResultInvalidNumberOfNsd</CODE></a> 350 </th> 351<td>Too many NS data files in NS archive.</td> 352 </tr> 353 <tr> 354 <th> 355<a href="../../nn/boss/ResultNsDataInvalidFormat/Overview.html"><CODE>nn::boss::ResultNsDataInvalidFormat</CODE></a> 356 </th> 357<td>The NS data format is invalid.</td> 358 </tr> 359 <tr> 360 <th> 361<a href="../../nn/boss/ResultAppNotExist/Overview.html"><CODE>nn::boss::ResultAppNotExist</CODE></a> 362 </th> 363<td>The specified application ID was not found.</td> 364 </tr> 365 <tr> 366 <th> 367<a href="../../nn/boss/ResultTaskNotExist/Overview.html"><CODE>nn::boss::ResultTaskNotExist</CODE></a> 368 </th> 369<td>The specified task ID was not found.</td> 370 </tr> 371 <tr> 372 <th> 373<a href="../../nn/boss/ResultTaskStepNotExist/Overview.html"><CODE>nn::boss::ResultTaskStepNotExist</CODE></a> 374 </th> 375<td>Specified task step was not found.</td> 376 </tr> 377 <tr> 378 <th> 379<a href="../../nn/boss/ResultApliIdAlreadyExist/Overview.html"><CODE>nn::boss::ResultApliIdAlreadyExist</CODE></a> 380 </th> 381<td>Another application of the same name is already registered.</td> 382 </tr> 383 <tr> 384 <th> 385<a href="../../nn/boss/ResultTaskIdAlreadyExist/Overview.html"><CODE>nn::boss::ResultTaskIdAlreadyExist</CODE></a> 386 </th> 387<td>Another task of the same name is already registered.</td> 388 </tr> 389 <tr> 390 <th> 391<a href="../../nn/boss/ResultTaskStepAlreadyExist/Overview.html"><CODE>nn::boss::ResultTaskStepAlreadyExist</CODE></a> 392 </th> 393<td>Another task step of the same name is already registered.</td> 394 </tr> 395 <tr> 396 <th> 397<a href="../../nn/boss/ResultInvalidSequence/Overview.html"><CODE>nn::boss::ResultInvalidSequence</CODE></a> 398 </th> 399<td>Sequence error (such as starting a task that is already running).</td> 400 </tr> 401 <tr> 402 <th> 403<a href="../../nn/boss/ResultDatabaseFull/Overview.html"><CODE>nn::boss::ResultDatabaseFull</CODE></a> 404 </th> 405<td>No space in task database (the task database is full and there are no tasks for which information can be deleted).</td> 406 </tr> 407 <tr> 408 <th> 409<a href="../../nn/boss/ResultCantUnregisterTask/Overview.html"><CODE>nn::boss::ResultCantUnregisterTask</CODE></a> 410 </th> 411<td>The current task state does not permit <CODE>UnregisterTask</CODE> to be called. </td> 412 </tr> 413 <tr> 414 <th> 415<a href="../../nn/boss/ResultTaskNotRegistered/Overview.html"><CODE>nn::boss::ResultTaskNotRegistered</CODE></a> 416 </th> 417<td>The task has not been registered in the task database.</td> 418 </tr> 419 <tr> 420 <th> 421<a href="../../nn/boss/ResultInvalidFileHandle/Overview.html"><CODE>nn::boss::ResultInvalidFileHandle</CODE></a> 422 </th> 423<td>Invalid file handle.</td> 424 </tr> 425 <tr> 426 <th> 427<a href="../../nn/boss/ResultInvalidTaskSchedulingPolicy/Overview.html"><CODE>nn::boss::ResultInvalidTaskSchedulingPolicy</CODE></a> 428 </th> 429<td>Invalid scheduling policy.</td> 430 </tr> 431 <tr> 432 <th> 433<a href="../../nn/boss/ResultInvalidHttpRequestHeader/Overview.html"><CODE>nn::boss::ResultInvalidHttpRequestHeader</CODE></a> 434 </th> 435<td>Error in an HTTP request header.</td> 436 </tr> 437 <tr> 438 <th> 439<a href="../../nn/boss/ResultInvalidHeadType/Overview.html"><CODE>nn::boss::ResultInvalidHeadType</CODE></a> 440 </th> 441<td>Invalid head type.</td> 442 </tr> 443 <tr> 444 <th> 445<a href="../../nn/boss/ResultStorageAccessPermission/Overview.html"><CODE>nn::boss::ResultStorageAccessPermission</CODE></a> 446 </th> 447<td>No permission to access storage.</td> 448 </tr> 449 <tr> 450 <th> 451<a href="../../nn/boss/ResultStorageInsufficiency/Overview.html"><CODE>nn::boss::ResultStorageInsufficiency</CODE></a> 452 </th> 453<td>Insufficient storage capacity.</td> 454 </tr> 455 <tr> 456 <th> 457<a href="../../nn/boss/ResultStorageNotFound/Overview.html"><CODE>nn::boss::ResultStorageNotFound</CODE></a> 458 </th> 459<td>There is no storage for the specified <CODE>APPID</CODE>.</td> 460 </tr> 461 <tr> 462 <th> 463<a href="../../nn/boss/ResultNsDataNotFound/Overview.html"><CODE>nn::boss::ResultNsDataNotFound</CODE></a> 464 </th> 465<td>There is no NS data.</td> 466 </tr> 467 <tr> 468 <th> 469<a href="../../nn/boss/ResultInvalidNsDataGetHeadSize/Overview.html"><CODE>nn::boss::ResultInvalidNsDataGetHeadSize</CODE></a> 470 </th> 471<td>Specified NS data <CODE>SIZE</CODE> parameter is invalid.</td> 472 </tr> 473 <tr> 474 <th> 475<a href="../../nn/boss/ResultNsDataListSizeShortage/Overview.html"><CODE>nn::boss::ResultNsDataListSizeShortage</CODE></a> 476 </th> 477<td><CODE>NsDataIdList</CODE> size is insufficient (list not big enough to store all the NS data serial IDs).</td> 478 </tr> 479 <tr> 480 <th> 481<a href="../../nn/boss/ResultNsDataListUpdated/Overview.html"><CODE>nn::boss::ResultNsDataListUpdated</CODE></a> 482 </th> 483<td>The target NSD group for BOSS storage was updated since the last time a list was obtained.</td> 484 </tr> 485 <tr> 486 <th> 487<a href="../../nn/boss/ResultNotConnectApWithLocation/Overview.html"><CODE>nn::boss::ResultNotConnectApWithLocation</CODE></a> 488 </th> 489<td>Not connected to an access point.</td> 490 </tr> 491 <tr> 492 <th> 493<a href="../../nn/boss/ResultNotConnectNetwork/Overview.html"><CODE>nn::boss::ResultNotConnectNetwork</CODE></a> 494 </th> 495<td>Not connected to a network.</td> 496 </tr> 497 <tr> 498 <th> 499<a href="../../nn/boss/ResultInvalidFriendcode/Overview.html"><CODE>nn::boss::ResultInvalidFriendcode</CODE></a> 500 </th> 501<td>Invalid friend code error.</td> 502 </tr> 503 <tr> 504 <th> 505<a href="../../nn/boss/ResultFileAccess/Overview.html"><CODE>nn::boss::ResultFileAccess</CODE></a> 506 </th> 507<td>Failed to access a file.</td> 508 </tr> 509 <tr> 510 <th> 511<a href="../../nn/boss/ResultTaskAlreadyPaused/Overview.html"><CODE>nn::boss::ResultTaskAlreadyPaused</CODE></a> 512 </th> 513<td>Already paused.</td> 514 </tr> 515 <tr> 516 <th> 517<a href="../../nn/boss/ResultTaskAlreadyResumed/Overview.html"><CODE>nn::boss::ResultTaskAlreadyResumed</CODE></a> 518 </th> 519<td>Already resumed.</td> 520 </tr> 521 <tr> 522 <th> 523<a href="../../nn/boss/ResultUnexpect/Overview.html"><CODE>nn::boss::ResultUnexpect</CODE></a> 524 </th> 525<td>Unexpected error.</td> 526 </tr> 527 <tr> 528 <th> 529<a href="../../nn/boss/ResultInvalidStorageParameter/Overview.html"><CODE>nn::boss::ResultInvalidStorageParameter</CODE></a> 530 </th> 531<td>An invalid value was set in the parameter specified for storage.</td> 532 </tr> 533 <tr> 534 <th> 535<a href="../../nn/boss/ResultInvalidPointer/Overview.html"><CODE>nn::boss::ResultInvalidPointer</CODE></a> 536 </th> 537<td>Invalid pointer.</td> 538 </tr> 539 <tr> 540<th class="category" colspan="2">Other</th> 541 </tr> 542 <tr> 543 <th> 544<a href="../../nn/boss/NsaDownloadAction/Overview.html"><CODE>nn::boss::NsaDownloadAction</CODE></a> 545 </th> 546<td>Class for representing NADL tasks. Use this to do such things as register NADL tasks.</td> 547 </tr> 548 <tr> 549 <th> 550<a href="../../nn/boss/NsData/Overview.html"><CODE>nn::boss::NsData</CODE></a> 551 </th> 552<td>Class for representing NS data. Use for NS data operations (such as reading).</td> 553 </tr> 554 <tr> 555 <th> 556<a href="../../nn/boss/NsDataIdList/Overview.html"><CODE>nn::boss::NsDataIdList</CODE></a> 557 </th> 558<td>Class for representing NS data ID lists. Use this to do such things as get a list of NS data to process.</td> 559 </tr> 560 <tr> 561 <th> 562<a href="../../nn/boss/StepIdList/Overview.html"><CODE>nn::boss::StepIdList</CODE></a> 563 </th> 564<td>Class for representing lists of task step IDs. Use this to do such things as get a task's list of steps. (The task step feature is not currently supported.)</td> 565 </tr> 566 <tr> 567 <th> 568<a href="../../nn/boss/Task/Overview.html"><CODE>nn::boss::Task</CODE></a> 569 </th> 570<td>Class for representing tasks. Use this to do such things as register or unregister a task, or for task operations.</td> 571 </tr> 572 <tr> 573 <th> 574<a href="../../nn/boss/TaskActionBase/Overview.html"><CODE>nn::boss::TaskActionBase</CODE></a> 575 </th> 576<td>Base class for task actions. There is no reason for an application to directly generate an instance of this class.</td> 577 </tr> 578 <tr> 579 <th> 580<a href="../../nn/boss/TaskAction/Overview.html"><CODE>nn::boss::TaskAction</CODE></a> 581 </th> 582<td>Class for representing task actions. This is the base class for specific task action classes such as NADL tasks. You can also directly generate an instance and use it to get information about task actions for a specific task.</td> 583 </tr> 584 <tr> 585 <th> 586<a href="../../nn/boss/TaskError/Overview.html"><CODE>nn::boss::TaskError</CODE></a> 587 </th> 588<td>Class for representing task errors. Use this to get task error information.</td> 589 </tr> 590 <tr> 591 <th> 592<a href="../../nn/boss/TaskIdList/Overview.html"><CODE>nn::boss::TaskIdList</CODE></a> 593 </th> 594<td>Class for representing task ID lists. Use this to do such things as get a list of registered tasks.</td> 595 </tr> 596 <tr> 597 <th> 598<a href="../../nn/boss/TaskOption/Overview.html"><CODE>nn::boss::TaskOption</CODE></a> 599 </th> 600<td>Class for representing task options. Use this to do such things as set the option information used when registering a task. (The task option feature is not currently supported.)</td> 601 </tr> 602 <tr> 603 <th> 604<a href="../../nn/boss/TaskPolicy/Overview.html"><CODE>nn::boss::TaskPolicy</CODE></a> 605 </th> 606<td>Class for representing task policies. Use this to do such things as set the policy information used when registering a task.</td> 607 </tr> 608 <tr> 609 <th> 610<a href="../../nn/boss/TaskStatus/Overview.html"><CODE>nn::boss::TaskStatus</CODE></a> 611 </th> 612<td>Class for representing task statuses. Use this to do such things as get the status of a task.</td> 613 </tr> </table> 614 </div> 615 </a> <a name="struct" id="struct"> 616<h2>Structures</h2> 617 <div class="section"> 618 <table class="members"> 619 <tr> 620 <th> 621<a href="../../nn/boss/TaskPolicyConfig/Overview.html"><CODE>nn::boss::TaskPolicyConfig</CODE></a> 622 </th> 623<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskPolicy</CODE> class.</td> 624 </tr> 625 <tr> 626 <th> 627<a href="../../nn/boss/TaskOptionConfig/Overview.html"><CODE>nn::boss::TaskOptionConfig</CODE></a> 628 </th> 629<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskOption</CODE> class.</td> 630 </tr> 631 <tr> 632 <th> 633<a href="../../nn/boss/TaskActionConfig/Overview.html"><CODE>nn::boss::TaskActionConfig</CODE></a> 634 </th> 635<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskAction</CODE> class.</td> 636 </tr> 637 <tr> 638 <th> 639<a href="../../nn/boss/TaskConfig/Overview.html"><CODE>nn::boss::TaskConfig</CODE></a> 640 </th> 641<td>Definition of an internal structure that maintains attribute information for the <CODE>Task</CODE> class.</td> 642 </tr> 643 <tr> 644 <th> 645<a href="../../nn/boss/TaskStatusInfo/Overview.html"><CODE>nn::boss::TaskStatusInfo</CODE></a> 646 </th> 647<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskStatus</CODE> class.</td> 648 </tr> 649 <tr> 650 <th> 651<a href="../../nn/boss/TaskErrorInfo/Overview.html"><CODE>nn::boss::TaskErrorInfo</CODE></a> 652 </th> 653<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskError</CODE> class.</td> 654 </tr> 655 <tr> 656 <th> 657<a href="../../nn/boss/ApplicationIdInfoList/Overview.html"><CODE>nn::boss::ApplicationIdInfoList</CODE></a> 658 </th> 659<td>Definition of an internal structure that maintains attribute information for the <CODE>ApplicationIdList</CODE> class.</td> 660 </tr> 661 <tr> 662 <th> 663<a href="../../nn/boss/TaskIdInfoList/Overview.html"><CODE>nn::boss::TaskIdInfoList</CODE></a> 664 </th> 665<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskIdList</CODE> class.</td> 666 </tr> 667 <tr> 668 <th> 669<a href="../../nn/boss/StepIdInfoList/Overview.html"><CODE>nn::boss::StepIdInfoList</CODE></a> 670 </th> 671<td>Definition of an internal structure that maintains attribute information for the <CODE>StepIdList</CODE> class.</td> 672 </tr> 673 <tr> 674 <th> 675<a href="../../nn/boss/NsDataIdInfoList/Overview.html"><CODE>nn::boss::NsDataIdInfoList</CODE></a> 676 </th> 677<td>Definition of an internal structure that maintains attribute information for the <CODE>NsDataIdList</CODE> class.</td> 678 </tr> 679 <tr> 680 <th> 681<a href="../../nn/boss/NsDataHeaderInfo/Overview.html">nn::boss::NsDataHeaderInfo</a> 682 </th> 683<td>Definition of the internal structure for storing NSD header information.</td> 684 </tr> </table> 685 </div> 686 </a> <a name="enum" id="enum"> 687<h2>Enumerated Types</h2> 688 <div class="section"> 689 <table class="members"> 690 <tr> 691 <td width="100"> </td> 692 <th> 693<a href="../../nn/boss/PositionBase.html"><CODE>PositionBase</CODE></a> 694 </th> 695<td>Group of constants that indicate the position of file read/writes.</td> 696 </tr> 697 <tr> 698 <td width="100"> </td> 699 <th> 700<a href="../../nn/boss/PropertyType.html"><CODE>PropertyType</CODE></a> 701 </th> 702<td>Constants specifying properties.</td> 703 </tr> 704 <tr> 705 <td width="100"> </td> 706 <th> 707<a href="../../nn/boss/SchedulingPolicy.html"><CODE>SchedulingPolicy</CODE></a> 708 </th> 709<td>Constants specifying scheduling policies.</td> 710 </tr> 711 <tr> 712 <td width="100"> </td> 713 <th> 714<a href="../../nn/boss/TaskPermission.html"><CODE>TaskPermission</CODE></a> 715 </th> 716<td>Constants specifying task permissions.</td> 717 </tr> 718 <tr> 719 <td width="100"> </td> 720 <th> 721<a href="../../nn/boss/TaskPriority.html"><CODE>TaskPriority</CODE></a> 722 </th> 723<td>Constants specifying task priorities.</td> 724 </tr> 725 <tr> 726 <td width="100"> </td> 727 <th> 728<a href="../../nn/boss/Action.html"><CODE>Action</CODE></a> 729 </th> 730<td>Constants specifying task actions.</td> 731 </tr> 732 <tr> 733 <td width="100"> </td> 734 <th> 735<a href="../../nn/boss/ExecOption.html"><CODE>ExecOption</CODE></a> 736 </th> 737<td>Constants specifying task execution options.</td> 738 </tr> 739 <tr> 740 <td width="100"> </td> 741 <th> 742<a href="../../nn/boss/TaskStateCode.html"><CODE>TaskStateCode</CODE></a> 743 </th> 744<td>Constants specifying task state codes.</td> 745 </tr> 746 <tr> 747 <td width="100"> </td> 748 <th> 749<a href="../../nn/boss/TaskResultCode.html"><CODE>TaskResultCode</CODE></a> 750 </th> 751<td>A task's exit state. You can use the <CODE>TaskGetResult</CODE> function to get these values after a task exits.</td> 752 </tr> 753 <tr> 754 <td width="100"> </td> 755 <th> 756<a href="../../nn/boss/TaskServiceStatus.html"><CODE>TaskServiceStatus</CODE></a> 757 </th> 758<td>Constants specifying task service statuses.</td> 759 </tr> 760 <tr> 761 <td width="100"> </td> 762 <th> 763<a href="../../nn/boss/HeaderInfoType.html"><CODE>HeaderInfoType</CODE></a> 764 </th> 765<td>Constants indicating the types of NSD header information obtained.</td> 766 </tr> 767 <tr> 768 <td width="100"> </td> 769 <th> 770<a href="../../nn/boss/FileDescriptor.html"><CODE>FileDescriptor</CODE></a> 771 </th> 772<td>Constants specifying task action file paths.</td> 773 </tr> 774 <tr> 775 <td width="100"> </td> 776 <th> 777<a href="../../nn/boss/ApInfoType.html"><CODE>ApInfoType</CODE></a> 778 </th> 779<td>Constants indicating an access point's identifier type.</td> 780 </tr> 781 <tr> 782 <td width="100"> </td> 783 <th> 784<a href="../../nn/boss/StorageType.html"><CODE>StorageType</CODE></a> 785 </th> 786<td>Constants indicating types of BOSS storage.</td> 787 </tr> 788 <tr> 789 <td width="100"> </td> 790 <th> 791<a href="../../nn/boss/ResultCode.html"><CODE>ResultCode</CODE></a> 792 </th> 793<td>Function result codes. Set as the <CODE>description</CODE> for <CODE>bossResult</CODE>, and used as the return value for <CODE>boss</CODE> functions.</td> 794 </tr> </table> 795 </div> 796 </a> <a name="typedef" id="typedef"> 797<h2><CODE>typedef</CODE> Definitions</h2> 798 <div class="section"> 799 <table class="members"> 800 <tr> 801 <td width="100" /> 802 <th> 803<a href="../../nn/boss/TaskPolicyConfig.html"><CODE>TaskPolicyConfig</CODE></a> 804 </th> 805<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskPolicy</CODE> class.</td> 806 </tr> 807 <tr> 808 <td width="100" /> 809 <th> 810<a href="../../nn/boss/TaskOptionConfig.html"><CODE>TaskOptionConfig</CODE></a> 811 </th> 812<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskOption</CODE> class.</td> 813 </tr> 814 <tr> 815 <td width="100" /> 816 <th> 817<a href="../../nn/boss/TaskActionConfig.html"><CODE>TaskActionConfig</CODE></a> 818 </th> 819<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskAction</CODE> class.</td> 820 </tr> 821 <tr> 822 <td width="100" /> 823 <th> 824<a href="../../nn/boss/TaskActionUploadConfig.html"><CODE>TaskActionUploadConfig</CODE></a> 825 </th> 826<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskActionUpload</CODE> class. (This is provided for future extensibility and cannot be used.)</td> 827 </tr> 828 <tr> 829 <td width="100" /> 830 <th> 831<a href="../../nn/boss/TaskActionDownloadConfig.html"><CODE>TaskActionDownloadConfig</CODE></a> 832 </th> 833<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskActionDownload</CODE> class.</td> 834 </tr> 835 <tr> 836 <td width="100" /> 837 <th> 838<a href="../../nn/boss/TaskActionSignalConfig.html"><CODE>TaskActionSignalConfig</CODE></a> 839 </th> 840<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskActionSignal</CODE> class. (This is provided for future extensibility and cannot be used.)</td> 841 </tr> 842 <tr> 843 <td width="100" /> 844 <th> 845<a href="../../nn/boss/TaskActionNsaDownloadConfig.html"><CODE>TaskActionNsaDownloadConfig</CODE></a> 846 </th> 847<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskActionNsaDownload</CODE> class.</td> 848 </tr> 849 <tr> 850 <td width="100" /> 851 <th> 852<a href="../../nn/boss/TaskConfig.html"><CODE>TaskConfig</CODE></a> 853 </th> 854<td>Definition of an internal structure that maintains attribute information for the <CODE>Task</CODE> class.</td> 855 </tr> 856 <tr> 857 <td width="100" /> 858 <th> 859<a href="../../nn/boss/TaskStatusInfo.html"><CODE>TaskStatusInfo</CODE></a> 860 </th> 861<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskStatus</CODE> class.</td> 862 </tr> 863 <tr> 864 <td width="100" /> 865 <th> 866<a href="../../nn/boss/TaskStepStatusInfo.html"><CODE>TaskStepStatusInfo</CODE></a> 867 </th> 868<td>Definition of the internal structure <CODE>TaskStepStatusInfo</CODE>. (This is used for internal processing.)</td> 869 </tr> 870 <tr> 871 <td width="100" /> 872 <th> 873<a href="../../nn/boss/TaskErrorInfo.html"><CODE>TaskErrorInfo</CODE></a> 874 </th> 875<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskError</CODE> class.</td> 876 </tr> 877 <tr> 878 <td width="100" /> 879 <th> 880<a href="../../nn/boss/ApplicationIdInfoList.html"><CODE>ApplicationIdInfoList</CODE></a> 881 </th> 882<td>Definition of an internal structure that maintains attribute information for the <CODE>ApplicationIdList</CODE> class.</td> 883 </tr> 884 <tr> 885 <td width="100" /> 886 <th> 887<a href="../../nn/boss/TaskIdInfoList.html"><CODE>TaskIdInfoList</CODE></a> 888 </th> 889<td>Definition of an internal structure that maintains attribute information for the <CODE>TaskIdList</CODE> class.</td> 890 </tr> 891 <tr> 892 <td width="100" /> 893 <th> 894<a href="../../nn/boss/StepIdInfoList.html"><CODE>StepIdInfoList</CODE></a> 895 </th> 896<td>Definition of an internal structure that maintains attribute information for the <CODE>StepIdList</CODE> class.</td> 897 </tr> 898 <tr> 899 <td width="100" /> 900 <th> 901<a href="../../nn/boss/NsDataIdInfoList.html"><CODE>NsDataIdInfoList</CODE></a> 902 </th> 903<td>Definition of an internal structure that maintains attribute information for the <CODE>NsDataIdList</CODE> class.</td> 904 </tr> 905 <tr> 906 <td width="100" /> 907 <th> 908<a href="../../nn/boss/NsDataHeaderInfo.html">NsDataHeaderInfo</a> 909 </th> 910<td>Definition of the internal structure for storing NSD header information.</td> 911 </tr> </table> 912 </div> 913 </a> <a name="constant" id="constant"> 914<h2>Constants</h2> 915 <div class="section"> 916 <table class="members"> 917 <tr> 918 <td width="100"> 919<span class="static_style" title="static">S</span> 920 </td> 921 <th> 922<span class="argument"><a href="../../nn/boss/DATA_TYPE_ALL.html"><CODE>DATA_TYPE_ALL</CODE></a></span> 923 </th> 924<td width="100"><CODE>const bit32</CODE></td> 925<td>NSD data type.</td> 926 </tr> 927 <tr> 928 <td width="100"> 929<span class="static_style" title="static">S</span> 930 </td> 931 <th> 932<span class="argument"><a href="../../nn/boss/DATA_TYPE_APPDATA.html"><CODE>DATA_TYPE_APPDATA</CODE></a></span> 933 </th> 934<td width="100"><CODE>const bit32</CODE></td> 935<td>Data type for applications.</td> 936 </tr> 937 <tr> 938 <td width="100"> 939<span class="static_style" title="static">S</span> 940 </td> 941 <th> 942<span class="argument"><a href="../../nn/boss/DATA_TYPE_NEWS.html"><CODE>DATA_TYPE_NEWS</CODE></a></span> 943 </th> 944<td width="100"><CODE>const bit32</CODE></td> 945<td>Data type for Notification lists. (This data type is used on the system side. The data cannot be directly obtained from the application. )</td> 946 </tr> 947 <tr> 948 <td width="100"> 949<span class="static_style" title="static">S</span> 950 </td> 951 <th> 952<span class="argument"><a href="../../nn/boss/DATA_TYPE_EXBANNER.html"><CODE>DATA_TYPE_EXBANNER</CODE></a></span> 953 </th> 954<td width="100"><CODE>const bit32</CODE></td> 955<td>Download contextual banner type.</td> 956 </tr> 957 <tr> 958 <td width="100"> 959<span class="static_style" title="static">S</span> 960 </td> 961 <th> 962<span class="argument"><a href="../../nn/boss/MAX_FILEPATH_LENGTH.html"><CODE>MAX_FILEPATH_LENGTH</CODE></a></span> 963 </th> 964<td width="100"><CODE>const u32</CODE></td> 965<td>BOSS system constant.</td> 966 </tr> 967 <tr> 968 <td width="100"> 969<span class="static_style" title="static">S</span> 970 </td> 971 <th> 972<span class="argument"><a href="../../nn/boss/MAX_URL_LENGTH.html"><CODE>MAX_URL_LENGTH</CODE></a></span> 973 </th> 974<td width="100"><CODE>const u32</CODE></td> 975<td>The maximum length for a URL.</td> 976 </tr> 977 <tr> 978 <td width="100"> 979<span class="static_style" title="static">S</span> 980 </td> 981 <th> 982<span class="argument"><a href="../../nn/boss/MAX_HTTP_HEADER_LABEL.html"><CODE>MAX_HTTP_HEADER_LABEL</CODE></a></span> 983 </th> 984<td width="100"><CODE>const u32</CODE></td> 985<td>Maximum length of HTTP header labels.</td> 986 </tr> 987 <tr> 988 <td width="100"> 989<span class="static_style" title="static">S</span> 990 </td> 991 <th> 992<span class="argument"><a href="../../nn/boss/MAX_HTTP_HEADER_VALUE.html"><CODE>MAX_HTTP_HEADER_VALUE</CODE></a></span> 993 </th> 994<td width="100"><CODE>const u32</CODE></td> 995<td>Maximum length of HTTP header values.</td> 996 </tr> 997 <tr> 998 <td width="100"> 999<span class="static_style" title="static">S</span> 1000 </td> 1001 <th> 1002<span class="argument"><a href="../../nn/boss/MAX_HTTP_HEADER.html"><CODE>MAX_HTTP_HEADER</CODE></a></span> 1003 </th> 1004<td width="100"><CODE>const u32</CODE></td> 1005<td>Maximum number of headers that can be registered.</td> 1006 </tr> 1007 <tr> 1008 <td width="100"> 1009<span class="static_style" title="static">S</span> 1010 </td> 1011 <th> 1012<span class="argument"><a href="../../nn/boss/MAX_ROOT_CA.html"><CODE>MAX_ROOT_CA</CODE></a></span> 1013 </th> 1014<td width="100"><CODE>const u32</CODE></td> 1015<td>Maximum number of built-in root CA certificates that can be configured.</td> 1016 </tr> 1017 <tr> 1018 <td width="100"> 1019<span class="static_style" title="static">S</span> 1020 </td> 1021 <th> 1022<span class="argument"><a href="../../nn/boss/MAX_CLIENT_CERT.html"><CODE>MAX_CLIENT_CERT</CODE></a></span> 1023 </th> 1024<td width="100"><CODE>const u32</CODE></td> 1025<td>Maximum number of built-in client certificates that can be configured.</td> 1026 </tr> 1027 <tr> 1028 <td width="100"> 1029<span class="static_style" title="static">S</span> 1030 </td> 1031 <th> 1032<span class="argument"><a href="../../nn/boss/TASK_ID_LENGTH.html"><CODE>TASK_ID_LENGTH</CODE></a></span> 1033 </th> 1034<td width="100"><CODE>const u32</CODE></td> 1035<td>The maximum number of characters in a task ID, including the zero terminator. </td> 1036 </tr> 1037 <tr> 1038 <td width="100"> 1039<span class="static_style" title="static">S</span> 1040 </td> 1041 <th> 1042<span class="argument"><a href="../../nn/boss/MAX_ERROR_MESSAGE.html"><CODE>MAX_ERROR_MESSAGE</CODE></a></span> 1043 </th> 1044<td width="100"><CODE>const u32</CODE></td> 1045<td>Maximum number of characters in an error message.</td> 1046 </tr> 1047 <tr> 1048 <td width="100"> 1049<span class="static_style" title="static">S</span> 1050 </td> 1051 <th> 1052<span class="argument"><a href="../../nn/boss/MAX_APPLICATION_ID.html"><CODE>MAX_APPLICATION_ID</CODE></a></span> 1053 </th> 1054<td width="100"><CODE>const u32</CODE></td> 1055<td>Maximum number of application IDs that can be registered.</td> 1056 </tr> 1057 <tr> 1058 <td width="100"> 1059<span class="static_style" title="static">S</span> 1060 </td> 1061 <th> 1062<span class="argument"><a href="../../nn/boss/MAX_TASK_ID.html"><CODE>MAX_TASK_ID</CODE></a></span> 1063 </th> 1064<td width="100"><CODE>const u32</CODE></td> 1065<td>Maximum number of task IDs that can be registered.</td> 1066 </tr> 1067 <tr> 1068 <td width="100"> 1069<span class="static_style" title="static">S</span> 1070 </td> 1071 <th> 1072<span class="argument"><a href="../../nn/boss/MAX_STEP_ID.html"><CODE>MAX_STEP_ID</CODE></a></span> 1073 </th> 1074<td width="100"><CODE>const u32</CODE></td> 1075<td>Maximum number of task steps that can be registered to one task.</td> 1076 </tr> 1077 <tr> 1078 <td width="100"> 1079<span class="static_style" title="static">S</span> 1080 </td> 1081 <th> 1082<span class="argument"><a href="../../nn/boss/CURRENT_STEP_ID.html"><CODE>CURRENT_STEP_ID</CODE></a></span> 1083 </th> 1084<td width="100"><CODE>const u32</CODE></td> 1085<td>ID of the currently running task step.</td> 1086 </tr> 1087 <tr> 1088 <td width="100"> 1089<span class="static_style" title="static">S</span> 1090 </td> 1091 <th> 1092<span class="argument"><a href="../../nn/boss/DEFAULT_STEP_ID.html"><CODE>DEFAULT_STEP_ID</CODE></a></span> 1093 </th> 1094<td width="100"><CODE>const u32</CODE></td> 1095<td>Task step ID when step ID is not specified.</td> 1096 </tr> 1097 <tr> 1098 <td width="100"> 1099<span class="static_style" title="static">S</span> 1100 </td> 1101 <th> 1102<span class="argument"><a href="../../nn/boss/U32_CANNOT_GET_DATA.html"><CODE>U32_CANNOT_GET_DATA</CODE></a></span> 1103 </th> 1104<td width="100"><CODE>const u32</CODE></td> 1105<td>Return value when a value cannot be obtained. Used by functions that return <CODE>u32</CODE> values.</td> 1106 </tr> 1107 <tr> 1108 <td width="100"> 1109<span class="static_style" title="static">S</span> 1110 </td> 1111 <th> 1112<span class="argument"><a href="../../nn/boss/MAX_LASTMODIFIED_LENGTH.html"><CODE>MAX_LASTMODIFIED_LENGTH</CODE></a></span> 1113 </th> 1114<td width="100"><CODE>const u32</CODE></td> 1115<td>Maximum number of characters in the HTTP communication at the time it was updated.</td> 1116 </tr> 1117 <tr> 1118 <td width="100"> 1119<span class="static_style" title="static">S</span> 1120 </td> 1121 <th> 1122<span class="argument"><a href="../../nn/boss/UNLIMITED_COUNT.html"><CODE>UNLIMITED_COUNT</CODE></a></span> 1123 </th> 1124<td width="100"><CODE>const u32</CODE></td> 1125<td>Specifies an unlimited remaining execution count.</td> 1126 </tr> 1127 <tr> 1128 <td width="100"> 1129<span class="static_style" title="static">S</span> 1130 </td> 1131 <th> 1132<span class="argument"><a href="../../nn/boss/MAX_STORAGE_ENTRY_COUNT.html"><CODE>MAX_STORAGE_ENTRY_COUNT</CODE></a></span> 1133 </th> 1134<td width="100"><CODE>const u32</CODE></td> 1135<td>Maximum file count in BOSS storage</td> 1136 </tr> 1137 <tr> 1138 <td width="100"> 1139<span class="static_style" title="static">S</span> 1140 </td> 1141 <th> 1142<span class="argument"><a href="../../nn/boss/DEFAULT_STORAGE_ENTRY_COUNT.html"><CODE>DEFAULT_STORAGE_ENTRY_COUNT</CODE></a></span> 1143 </th> 1144<td width="100"><CODE>const u32</CODE></td> 1145<td>Default value for the file count in BOSS storage</td> 1146 </tr> 1147 <tr> 1148 <td width="100"> 1149<span class="static_style" title="static">S</span> 1150 </td> 1151 <th> 1152<span class="argument"><a href="../../nn/boss/MAX_STORAGE_RECYCLE_COUNT.html"><CODE>MAX_STORAGE_RECYCLE_COUNT</CODE></a></span> 1153 </th> 1154<td width="100"><CODE>const u32</CODE></td> 1155<td>Maximum number of files that can be recycled in BOSS storage (the maximum value is the sum of the file count and resume count set in the storage options).)</td> 1156 </tr> </table> 1157 </div> 1158 </a> <a name="function" id="function"> 1159<h2>Functions</h2> 1160 <div class="section"> 1161 <table class="members"> 1162 <tr> 1163<th class="category" colspan="3">Other</th> 1164 </tr> 1165 <tr> 1166 <td width="100"> </td> 1167 <th> 1168<a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> 1169 </th> 1170<td>Initializes the BOSS library. Call this function once before using the BOSS library.</td> 1171 </tr> 1172 <tr> 1173 <td width="100"> </td> 1174 <th> 1175<a href="../../nn/boss/Finalize.html"><CODE>Finalize</CODE></a> 1176 </th> 1177<td>Closes the BOSS library. Call this function once when you are finished using the BOSS library.</td> 1178 </tr> 1179 <tr> 1180 <td width="100"> </td> 1181 <th> 1182<a href="../../nn/boss/RegisterPrivateRootCa.html"><CODE>RegisterPrivateRootCa</CODE></a> 1183 </th> 1184<td>Registers the independent root CA certificate in the BOSS library. They are used when using HTTPS communication as a connection when executing a task.<br />There is no need to call this function if an independent root CA certificate is not used.</td> 1185 </tr> 1186 <tr> 1187 <td width="100"> </td> 1188 <th> 1189<a href="../../nn/boss/RegisterPrivateClientCert.html"><CODE>RegisterPrivateClientCert</CODE></a> 1190 </th> 1191<td>Registers the independent client certificate and private key in the BOSS library. They are used when using HTTPS communication for the connection when executing a task<br />There is no need to call this function if an independent client certificate is not used.</td> 1192 </tr> 1193 <tr> 1194 <td width="100"> </td> 1195 <th> 1196<a href="../../nn/boss/RegisterTask.html"><CODE>RegisterTask</CODE></a> 1197 </th> 1198<td>Registers a task. </td> 1199 </tr> 1200 <tr> 1201 <td width="100"> </td> 1202 <th> 1203<a href="../../nn/boss/UnregisterTask.html"><CODE>UnregisterTask</CODE></a> 1204 </th> 1205<td>Deletes a registered task.</td> 1206 </tr> 1207 <tr> 1208 <td width="100"> </td> 1209 <th> 1210<a href="../../nn/boss/ReconfigureTask.html"><CODE>ReconfigureTask</CODE></a> 1211 </th> 1212<td>The property settings for registered tasks can be changed.</td> 1213 </tr> 1214 <tr> 1215 <td width="100"> </td> 1216 <th> 1217<a href="../../nn/boss/GetTaskIdList.html"><CODE>GetTaskIdList</CODE></a> 1218 </th> 1219<td>Gets a list of registered task IDs.</td> 1220 </tr> 1221 <tr> 1222 <td width="100"> </td> 1223 <th> 1224<a href="../../nn/boss/GetStepIdList.html"><CODE>GetStepIdList</CODE></a> 1225 </th> 1226<td>Gets a list of all steps for the specified registered task.</td> 1227 </tr> 1228 <tr> 1229 <td width="100"> </td> 1230 <th> 1231<a href="../../nn/boss/RegisterStorage.html"><CODE>RegisterStorage</CODE></a> 1232 </th> 1233<td>Registers BOSS storage.</td> 1234 </tr> 1235 <tr> 1236 <td width="100"> </td> 1237 <th> 1238<a href="../../nn/boss/UnregisterStorage.html"><CODE>UnregisterStorage</CODE></a> 1239 </th> 1240<td>Unregisters registered BOSS storage.</td> 1241 </tr> 1242 <tr> 1243 <td width="100"> </td> 1244 <th> 1245<a href="../../nn/boss/GetStorageInfo.html"><CODE>GetStorageInfo</CODE></a> 1246 </th> 1247<td>Gets the size of the registered BOSS storage region.<br />Can also be used to check if the BOSS storage is registered.</td> 1248 </tr> 1249 <tr> 1250 <td width="100"> </td> 1251 <th> 1252<a href="../../nn/boss/GetNewArrivalFlag.html"><CODE>GetNewArrivalFlag</CODE></a> 1253 </th> 1254<td>Checks if new NS data has been downloaded.<br />However, the new arrival flag does not change if it is not set by the downloaded NS data.</td> 1255 </tr> 1256 <tr> 1257 <td width="100"> </td> 1258 <th> 1259<a href="../../nn/boss/RegisterNewArrivalEvent.html"><CODE>RegisterNewArrivalEvent</CODE></a> 1260 </th> 1261<td>Registers an event to be signaled when new NS data is received.</td> 1262 </tr> 1263 <tr> 1264 <td width="100"> </td> 1265 <th> 1266<a href="../../nn/boss/GetNewArrivalEvent.html"><CODE>GetNewArrivalEvent</CODE></a> 1267 </th> 1268<td>This is the old (deprecated) name for <a href="../../nn/boss/RegisterNewArrivalEvent.html"><CODE>nn::boss::RegisterNewArrivalEvent</CODE></a>.<br />Avoid using this: it only exists for compatibility.</td> 1269 </tr> 1270 <tr> 1271 <td width="100"> </td> 1272 <th> 1273<a href="../../nn/boss/SetOptoutFlag.html"><CODE>SetOptoutFlag</CODE></a> 1274 </th> 1275<td>Sets the OptOut flag.</td> 1276 </tr> 1277 <tr> 1278 <td width="100"> </td> 1279 <th> 1280<a href="../../nn/boss/GetOptoutFlag.html"><CODE>GetOptoutFlag</CODE></a> 1281 </th> 1282<td>Gets the OptOut flag.</td> 1283 </tr> 1284 <tr> 1285 <td width="100"> </td> 1286 <th> 1287<a href="../../nn/boss/GetNsDataIdList.html"><CODE>GetNsDataIdList</CODE></a> 1288 </th> 1289<td>Specifies the data type and gets a list of NS data entries from the expanded save data region where the BOSS storage is registered.</td> 1290 </tr> 1291 <tr> 1292 <td width="100"> </td> 1293 <th> 1294<a href="../../nn/boss/GetOwnNsDataIdList.html"><CODE>GetOwnNsDataIdList</CODE></a> 1295 </th> 1296<td>Excludes the shared NS data and gets the application's list of NS content from the expanded save data region where the BOSS storage is registered.</td> 1297 </tr> 1298 <tr> 1299 <td width="100"> </td> 1300 <th> 1301<a href="../../nn/boss/GetNewDataNsDataIdList.html"><CODE>GetNewDataNsDataIdList</CODE></a> 1302 </th> 1303<td>Specifies the data type and gets a list of newly arrived NS data from the expanded save data region where the BOSS storage is registered.</td> 1304 </tr> 1305 <tr> 1306 <td width="100"> </td> 1307 <th> 1308<a href="../../nn/boss/GetOwnNewDataNsDataIdList.html"><CODE>GetOwnNewDataNsDataIdList</CODE></a> 1309 </th> 1310<td>Excludes the shared NS data and gets the application's list of NS content from the expanded save data region where the BOSS storage is registered.</td> 1311 </tr> 1312 <tr> 1313 <td width="100"> </td> 1314 <th> 1315<a href="../../nn/boss/GetErrorCode.html"><CODE>GetErrorCode</CODE></a> 1316 </th> 1317<td>The error code is acquired from the task result code (<a href="../../nn/boss/TaskResultCode.html"><CODE>TaskResultCode</CODE></a>).</td> 1318 </tr> </table> 1319 </div> 1320 </a> 1321<h2>Revision History</h2> 1322 <div class="section"> 1323 <dl class="history"> 1324 <dt>2011/03/28</dt> 1325<dd>Added note about Nintendo server maintenance (note is valid only from late March to early April).<br /> 1326 </dd> 1327 <dt>2010/09/16</dt> 1328<dd>Initial version.<br /> 1329 </dd> 1330 </dl> 1331 </div> 1332 <hr><p>CONFIDENTIAL</p></body> 1333</html>