nn::boss::TaskOption::SetProperty Member Function

Syntax

nn::Result SetProperty(
     PropertyType type,
     const void * pValue,
     size_t size
);

Parameters

Name Description
in type Specifies the property identifier.
in 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
Result::IsSuccess Set successfully.
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

Sets a property value in 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_STEP: Task step ID number. Data type is u8.

Revision History

2010/09/16
Initial version.

CONFIDENTIAL