nn::boss::RegisterTask Function

nn::Result RegisterTask(
     Task * pTask,
     TaskPolicy * pPolicy,
     TaskAction * pAction,
     TaskOption * pOption = NULL,
     u8 taskStep = DEFAULT_STEP_ID
);

	Name	Description
in	pTask	Specifies a task ID by task.
in	pPolicy	Specifies a task policy.
in	pAction	Specifies a task action. (Currently, the only related tasks are in the NsaDownloadAction class.)
in	pOption	Specifies task options. (Can be omitted) Note: This parameter is not currently supported because it is used with extended features. Do not specify it.
in	taskStep	Specifies a task step ID. (Can be omitted if there is only one task execution step) Note: This parameter is for a feature extension and is currently not supported. Do not specify it.

Returns the function's execution result. Returns one of the Result values listed below.

Value	Description
Result::IsSuccess	Registration successful.
ResultInvalidTaskId	The pTask parameter is NULL. Alternatively, the pTask parameter is uninitialized, or the pointer of the task ID specified by pTask is NULL or a zero-length string.
ResultInvalidPolicy	The pPolicy parameter is NULL.
ResultInvalidAction	The pAction parameter is NULL.
ResultInvalidTaskPriority	The task execution priority specification is out-of-range. Confirm that it is in the range of TaskPriority.
ResultTaskPermissionOutOfRange	The task permission condition specification is out-of-range. Confirm that it is in the range of TaskPermission.
ResultSchedulingPolicyOutOfRange	The scheduling policy is out of range. Confirm that it is in the range of SchedulingPolicy.
ResultInvalidTaskTargetDuration	The task duration is invalid. (This is for future extensibility.)
ResultActionCodeOutOfRange	The task action code is out of range. Confirm that it is in the range of Action.
ResultInvalidUrl	The URL string pointer is NULL or a zero-length string.
ResultApInfoTypeOutOfRange	The AP information type is out of range. Confirm that it is in the range of ApInfoType.
ResultInvalidFilePath	The file path string pointer is NULL or a zero-length string.
ResultInvalidOption	The pOption parameter is uninitialized or the option code is out of range. Confirm that it is in the range of ExecOption.
ResultStorageNotFound	Storage has not been registered for the corresponding application ID.
ResultTaskIdAlreadyExist	A task having the same task ID is already registered.
ResultDatabaseFull	BOSS storage and tasks cannot be registered because the maximum number of registered application IDs and tasks has been reached.
ResultIpcNotSessionInitialized	The session has not been initialized. This Result is returned if this function is called before the Initialize function. Always call the Initialize function first before using the BOSS library.
A value other than the above.	Unexpected error (see boss_Result.h for error details).

Registers a task.

To register tasks, you must prepare instances of the subclass of TaskPolicy class and the TaskAction class (currently only NsaDownloadAction available). 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 Initialize function. A task execution instruction can be issued by calling the nn::boss::Task::Start function for a registered task.

　

【Common Task Registration Errors】

1. If BOSS storage has not been registered (ResultStorageNotFound) when registering an NADL task, be sure to register BOSS storage for NADL task using RegisterStorage.

2. A task with the same task ID is already registered (ResultTaskIdAlreadyExist).
Either use the UnregisterTask function to delete one of the tasks in question, or reuse the task that has already been registered.

3. The task cannot be registered because the task database is full and no existing tasks can be deleted (ResultDatabaseFull).
When the task database is full, tasks with a remaining execution count of zero are automatically deleted so that new tasks can be registered successfully. However, if no tasks can be deleted because none of them have a remaining execution count of zero, this error occurs. If it is possible to delete any of the tasks registered by the application itself, you can resolve this issue by deleting one of those tasks by using the UnregisterTask function and then attempting to register the new task again.( The application can run the GetTaskIdList function to get a list of the task IDs for tasks it has registered.)
Alternatively, after some time elapses, it is possible that the execution count of some other task (maybe even some other application's task) will reach zero, allowing your task to be registered successfully. You can handle this by retrying task registration after waiting for the next application startup.

2010/09/16

Initial version.