nn::boss::GetStepIdList Function

Syntax

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

Arguments

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

Return Values

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, the storage, nor the private certificate are registered.
ResultTaskNotExist The specified task ID was not found.
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).

Description

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.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL