nn::boss::GetTaskIdList Function

Syntax

nn::Result GetTaskIdList(
     TaskIdList * pTaskIdList
);

Parameters

Name Description
out pTaskIdList Specifies an object storing a list of task IDs.

Return Values

Returns the function's result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Retrieval successful.
ResultAppNotExist There is no information on the calling application. Returns this error if the application has not run any tasks on BOSS or registered any BOSS storage.
ResultInvalidTaskIdList The pointer for getting the task ID list is NULL.
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).

Description

Gets a list of registered task IDs.

You must create an instance of the TaskIdList class in advance.
Note that this instance requires approximately 1 KB of memory to get a list.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL