nn::boss::Task::GetStateDetail Member Function

nn::Result GetStateDetail(
     TaskStatus * pStatus,
     bool acknowledge = false,
     u8 * pStepId = NULL,
     u8 taskStep = CURRENT_STEP_ID
);

	Name	Description
out	pStatus	Returns the task status.
in	acknowledge	To allow confirmation of execution results once the task finishes running, this argument stores a TaskStateCode from the TaskStatus object that indicates execution is complete. Calling the function with this flag set to true clears the "execution complete" status. Tasks whose execution counts are non-zero are rescheduled immediately after the previous task execution completes. This causes the state to switch to TASK_WAITING_TIMER for the next call. (Optional.)
out	pStepId	Returns the task step ID.
in	taskStep	Specifies a task step ID. (Defaults to the current step if omitted.)

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

Value	Description
Result::IsSuccess	Reset state obtained successfully.
ResultInvalidTaskStatus	The task status pointer is NULL.
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	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 thing when you use the BOSS library.
A value other than the above.	Unexpected error (see boss_Result.h for error details).

Gets the task status.

You must prepare a TaskStatus instance beforehand. Note that this instance requires approximately 128 bytes of memory. See the GetProperty member function of the TaskStatus class for more information about obtaining the values of the attributes.

2010/11/10

Initial version.