nn::boss::TaskError::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
Result::IsSuccess	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.

Identifier: Description
TASK_ERROR_RESULT_CODE: The task result code. The data type is TaskResultCode.
TASK_ERROR_CODE: A 32-bit bit-array value corresponding to the nnResult that is a cause of the task execution error. The data type is bit 32.
TASK_ERROR_MESSAGE: A communications error message during task execution. Its data type is char[MAX_ERROR_MESSAGE].

2010/09/16

Initial version.