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 cancelled 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 registered.
ResultIpcNotSessionInitialized	Either a session had not been initialized or there were incompatible permissions. This Result is returned if this function is called before either the Initialize or the InitializePriviledged function is called. When using the BOSS library, always begin by calling either the Initialize or the InitializePriviledged function.
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. For the cancel state task, calling the GetState function will return TASK_STOPPED as the task state.

2010/09/16

Initial version.