nn::boss::TaskOption::GetProperty Member Function

Syntax

nn::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. Call this function after allocating memory for the description's data type. It can be used for the following properties.
Identifer: Description
TASK_EXEC_OPTION: Task execution options. Data type is ExecOption.
TASK_STEP: Task step ID number. Data type is u8.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL