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