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.

It can be used for the following properties. Call this function after allocating memory for the description's data type.
You must call the nn::boss::Task::GetStateDetail function at the point in time when you want to check the status.

Identifier: Description
TASK_STATE_CODE: Task state information. Its data type is TaskStateCode.
TASK_RESULT_CODE: Task execution result code. Its data type is TaskResultCode.
TASK_SERVICE_STATUS: Service availability status at the URL specified in the task attributes. Its data type is TaskServiceStatus.
TASK_SERVICE_TERMINATED: Availability flag of the service at the URL specified in the task attributes. Its data type is bool.
TASK_COMM_ERROR_CODE: Communications error code during task execution. Its data type is u32.
TASK_CURRENT_PRIORITY: Current task execution priority. Its data type is u8.
TASK_EXECUTE_COUNT: Task execution count. The data type is u32. (Note: This execution count is not is not updated as often as the value returned by the TaskPolicy::GetProperty function in response to TASK_EXEC_COUNT. Use TaskPolicy::GetProperty when you want to get the most recent value.)
TASK_PENDING_TIME: Time elapsed since the scheduled task start time. Its data type is u32 (seconds).
TASK_START_TIME: Scheduled task start time, based on a calendar beginning January 1, 2000. Its data type is s64 (seconds).
TASK_PROGRESS: Number of bytes downloaded. Its data type is u32.
TASK_DATA_SIZE: Total number of bytes to download from the target URL. Its data type is u32.
TASK_CURRENT_STEP: ID of the currently running task step. Its data type is u8.
TASK_LAST_MODIFIED_TIME: Last modified date and time, as returned in the HTTP response header. Data type is char[MAX_LASTMODIFIED_LENGTH].

2010/09/16

Initial version.