Ets_Obj_Attr_Symbol_Get()
Abstract
Retrieves the value of the symbol portion of a symbol map attribute.
Syntax
Ets_Obj_Attr_Symbol_Get (obj_hndl, attr_name, symbol_buf_ptr)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Handle of object of interest. |
attr_name |
const char * |
Name of attribute of interest. |
symbol_buf_ptr |
char * |
Returns the value of the symbol. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the attribute exists, is symbolic, and is valid. EtsC_Compcode_Failure otherwise.
Header
ets_api_obj.h
Details
A symbolic attribute maps a value to symbolic name. This concept can be used to conveniently refer to numeric values by using easy-to-remember strings. The purpose of this function is to retrieve the symbol field of a specific symbol map attribute of an object. The object need not be installed in a model. You may need to set the model attribute first. If the specified attribute is not symbolic, then an error condition is returned.