nn::boss::TaskStatus::GetProperty Member Function

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. The nnboss::GetTaskStatus function must be called when you want to check the status. It can be used for the following properties.
Identifier: Description
TASK_STATE_CODE: Task state information. Data type is TaskStateCode.
TASK_RESULT_CODE: Task result code. Data type is TaskResultCode.
TASK_SERVICE_STATUS: Status of the service pointed to by the URL specified in the task attributes. Data type is TaskServiceStatus.
TASK_SERVICE_TERMINATED: Availability flag of the service pointed to by the URL specified in the task attributes. Data type is bool.
TASK_COMM_ERROR_CODE: Communications error code during task execution. Data type is u32.
TASK_CURRENT_PRIORITY: Priority of the currently running task. It has a data type of u8.
TASK_EXECUTE_COUNT: Task execution count. Data type is u32.
TASK_PENDING_TIME: Time elapsed since scheduled task start. Data type is u32 (seconds).
TASK_START_TIME: Scheduled task start time, based on a calendar beginning 1 January 2000. Data type is S64 (nanoseconds).
TASK_PROGRESS: Number of bytes downloaded. Data type is u32.
TASK_DATA_SIZE: Total number of bytes to download from specified URL. Data type is u32.
TASK_CURRENT_STEP: Currently running task step ID. It has a data type of u8.
TASK_LAST_MODIFIED_TIME: Last modified time, as returned in the HTTP response header. Data type is char[MAX_LASTMODIFIED_LENGTH].

2010/09/16

Initial version.