nn::boss::Task::GetInfo Member Function

nn::Result GetInfo(
     TaskPolicy * pPolicy,
     TaskAction * pAction,
     TaskOption * pOption,
     u8 taskStep = CURRENT_STEP_ID
);

	Name	Description
out	pPolicy	Specifies a task policy.
out	pAction	Specifies a task action.
out	pOption	Specifies task options.
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
ResultSuccess	Retrieval successful.
ResultInvalidTaskId	The task ID pointer is NULL or a zero-length string.
ResultInvalidPolicy	The policy information pointer is NULL.
ResultInvalidAction	The task action pointer is NULL.
ResultInvalidOption	The task option pointer is NULL, or the option code is invalid.
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 the InitializePriviledged function is called. 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).

Gets information about a registered task. You must prepare instances of the TaskPolicy, TaskAction, and TaskOption classes beforehand. See the GetProperty member function of each class for more information about obtaining the values of the attributes.

2010/09/16

Initial version.