GetActivePriority

nn::boss::Task::GetActivePriority Member Function

Syntax

nn::Result GetActivePriority(
     TaskPriority * pPriority
);

Parameters

Name Description
out pPriority Returns the current task priority.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
Result::IsSuccess Retrieval successful.
ResultInvalidTaskId The task ID pointer is NULL or a zero-length string.
ResultTaskNotExist The specified task ID was not found. Confirm whether it is registered yet.
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 first thing when you use the BOSS library.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Gets the current task execution priority.

Revision History

2011/10/27
Initial version.

CONFIDENTIAL