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

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

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

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).

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

2010/09/16

Initial version.