nn::boss::GetStepIdList Function

nn::Result GetStepIdList(
const char * pTaskId,
StepIdList * pStepIdList
);

	Name	Description
in	pTaskId	Specifies a registered task.
out	pStepIdList	Specifies an object storing a list of task step IDs.

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.
ResultInvalidStepIdList	The pointer for getting the step ID list is NULL.
ResultAppNotExist	Occurs when neither the task, storage, nor the proprietary certificate has been registered.
ResultTaskNotExist	The specified task ID was not found.
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).

Gets a list of all steps for the specified registered task. You must create an instance of the StepIdList class in advance. Note that this instance requires approximately 256 bytes of memory to get a list.

2010/09/16

Initial version.