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

Syntax

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. The nnboss::GetTaskStatus function must be called 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 results code. Its data type is TaskResultCode. TASK_SERVICE_STATUS: Availability status of the service 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: Priority of the currently running task. Its data type is u8. TASK_EXECUTE_COUNT: Task execution count. Its data type is u32. TASK_PENDING_TIME: Time elapsed since 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 specified URL. Its data type is u32. TASK_CURRENT_STEP: The currently running task step ID. 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].

Revision History

2010/09/16
Initial version.

CONFIDENTIAL