nn::boss::UnregisterTask Function

+nn::Result UnregisterTask(
Task * pTask,
u8 taskStep = DEFAULT_STEP_ID
);

	Name	Description
in	pTask	Specifies a registered task.
in	taskStep	Specifies a task step ID. (May be omitted if there is only one task step to be executed)

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

Value	Description
ResultSuccess	Deletion successful.
ResultInvalidTaskId	The task ID pointer is NULL or a zero-length string.
ResultTaskNotExist	The specified task ID was not found. Confirm whether it has already been registered.
ResultCantUnregisterTask	The task cannot be deleted because of its state. (For example, it may currently be running or have already been scheduled.) Call the Cancel() method of the Task, and then try to delete it.
ResultIpcNotSessionInitialized	Either a session had not been initialized or there were incompatible permissions. This Result value is returned if you call this function before Initialize or InitializePrivileged. Always call Initialize or InitializePrivileged first when you use the BOSS library.
A value other than the above.	Unexpected error (see boss_Result.h for details).

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 Task class's Cancel function beforehand as necessary.

2010/09/16

Initial version.