Ets_Obj_Attr_Intended_Status_Set()
Abstract
Sets the Intended status of an object attribute.
Syntax
Ets_Obj_Attr_Intended_Status_Set (obj_hndl, attr_name, is_intended)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Handle of the object of interest. |
attr_name |
const char * |
Name of the attribute of interest. |
is_intended |
EtsT_Boolean |
Indicates whether or not the attribute should be set to Intended. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the operation was successful; EtsC_Compcode_Failure otherwise.
Header
ets_api_obj.h
Details
If is_intended is EtsC_False, this function causes the attribute’s value to “revert” to its inherited value. There is no way to make an attribute get its value from the process model’s default value (skipping the underlying model’s value assignment). To make the attribute get the process default value, you must set (network-intend) the default value on the network object. (See the Details for Ets_Obj_Attr_Intended_Status_Get() for a further description of intended status.)