nn::boss::GetErrorCode Function

nn::Result GetErrorCode(
     u32 * pOut,
     TaskResultCode targetResult
);

	Name	Description
out	pOut	Buffer for storing error codes.
in	targetResult	Target result codes.

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

Value	Description
Result::IsSuccess	Retrieval successful.
ResultUnexpect	An unexpected result code (result code for which an error code is not allocated) is passed. (This Result is also returned when the pOut parameter is NULL.)
ResultIpcNotSessionInitialized	The session has not been initialized. This Result is returned if this function is called before the Initialize function is called. Always call the Initialize function before using the BOSS library.
A value other than the above.	Unexpected error (see boss_Result.h for error details).

The error code is acquired from the task result code (TaskResultCode).

The task result code is acquired with nn::boss::Task::GetResult.

If the task result is UNKNOWN_ERROR, a value not included in the enumerated type TaskResultCode may be returned as the task result code. However, even this type of value can be converted to an error code. (In the case of UNKNOWN_ERROR, the task result code used is the sum of the value of the UNKNOWN_ERROR enumerator plus the ID of the module in which the error occurred (nnResult::Module).)

2011/10/27

Initial version.