Ets_Obj_Attr_Get_As_String()
Abstract
Gets the value of a given ETS object’s attribute, as a string.
Syntax
Ets_Obj_Attr_Get_As_String (obj_hndl, attr_name, value_buf)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Handle of the object of interest. |
attr_name |
const char * |
Name of the attribute of interest. |
value_buf |
char * |
Buffer to be filled with a string representation of the attribute value. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the value was successfully obtained; EtsC_Compcode_Failure otherwise.
Header
ets_api_obj.h
Details
This function returns what would be shown in the value column of the Edit Attributes dialog box: a string (if the value is simple), a symbol (if there is one), and something like “(...)” for non-symbol compound values.
value_buf receives a copy of the string, and must be allocated and destroyed by the client.