nn::boss::GetStepIdList Functionnn::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. |
Result values listed below. | Value | Description |
|---|---|
Result::IsSuccess |
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 |
There is no information on the calling application. Occurs when the task, storage, and private certificate are not registered. |
ResultTaskNotExist |
The specified task ID was not found. |
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 before using the BOSS library. |
| 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.
Note: This is an API feature extension and cannot be used currently.
CONFIDENTIAL