nn::boss::Task::Cancel Member Function

nn::Result Cancel(
     void
);

None.

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

Value	Description
ResultSuccess	Successfully canceled the running task.
ResultInvalidTaskId	The task ID pointer is NULL or a zero-length string.
ResultTaskNotExist	The specified task ID was not found. Confirm whether it is registered yet.
ResultIpcNotSessionInitialized	Either the session is not initialized or there are incompatible permissions. This Result is returned if this function is called before the Initialize or InitializePrivileged function. Always call the Initialize or InitializePrivileged function first when you use the BOSS library.
A value other than the above.	Unexpected error (see boss_Result.h for error details).

Cancels a running task. You can use the Start function to restart a task that has been canceled. If a task has been canceled, calling the GetState function will return TASK_STOPPED as the task's state. If the task in question was running when it was canceled, task execution is canceled and TASK_CANCELED is returned as the task's execution result.

2010/09/16

Initial version.