nn::boss::TaskPolicy::GetProperty Member Function

Syntax

nn::Result GetProperty(
     PropertyType type,
     void * pValue,
     size_t size
);

Arguments

Name Description
in type Specifies the property identifier.
out pValue Specifies the value.
in size Specifies the value size.

Return Values

Returns the function's execution result. Returns one of the Result values listed below.
Value Description
ResultSuccess Retrieval successful.
ResultInvalidPropertyValue The property value pointer is NULL.
ResultInvalidPropertyType The property type is not supported.
A value other than the above. Unexpected error (see boss_Result.h for error details).

Description

Gets a property value from the class.

It can be used for the following properties. Call this function after allocating memory for the description's data type. Identifier: Description
TASK_PRIORITY: Task priority as set on task registration. Data type is TaskPriority. TASK_SCHEDULING_POLICY: Scheduling policy of the task. The data type is SchedulingPolicy. TASK_EXEC_INTERVAL: Task execution interval. Its data type is u32 (seconds). TASK_EXEC_COUNT: Task execution count. The data type is u16. TASK_PERMISSION: Task execution restrictions as set by Parental Controls and EULA permissions. The data type is TaskPermission. It is TASK_PERMISSION_IN_PARENTAL_CONTROL if it has not been set explicitly.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL