Ets_Obj_Attr_Set_From_String()
Abstract
Sets the value of the specified attribute of specified object using a string.
Syntax
Ets_Obj_Attr_Set_From_String (obj_hndl, attr_name, value_str)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Handle to object being modified. |
attr_name |
const char * |
Name of attribute being modified. |
value_str |
const char * |
String used to specify the new value. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the attribute exists and was set. EtsC_Compcode_Failure otherwise.
Header
ets_api_obj.h
Details
The specified object must already have the named attribute, that attribute must be modifiable, and the value string must be either in the attribute’s symbol map or appropriate for the attribute’s type.
Compound object attributes can only be set with a symbol in the attribute’s symbol map. For integer and double attributes, if the string is not a symbol, the string should be a valid, stringified numeric value. For boolean attributes, the strings “1”, “enabled”, “true”, and “TRUE” represent the true value, while other strings represent the false value. For color attributes, the string should either be in the “#xxxxxx” (where “x” is a hexidecimal digit) or the “RGBnnn” (where “n” is a digit in the range 0–3, inclusive) form.