GetError

nn::boss::Task::GetError Member Function

Syntax

nn::Result GetError(
     TaskError * pTaskError,
     u8 * pStepId = NULL,
     u8 taskStep = CURRENT_STEP_ID
);

Parameters

Name Description
out pTaskError Returns the task error state.
out pStepId Returns the task step ID.
in taskStep Specifies a task step ID. (Defaults to the current step if omitted.)

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Retrieval successful.
ResultInvalidTaskError The pointer to the task error information 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).

Description

Gets the task error state.

You must prepare a TaskError instance beforehand. Note that this instance requires approximately 136 bytes of memory.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL