Ets_Obj_Attr_Default_Symbol_Get()
Abstract
Obtains the symbol (if any) corresponding to the default value of an attribute.
Syntax
Ets_Obj_Attr_Default_Symbol_Get (attr_desc_model_hndl, symbol_buf_ptr)
| Argument | Type | Description |
|---|---|---|
attr_desc_model_hndl |
EtsT_Model_Handle |
Handle to the attribute description for the attribute of interest. |
symbol_buf_ptr |
char * |
Area to be filled with the symbol name. This area must be at least one character larger than the size of the symbol name. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if a symbol name can be obtained; EtsC_Compcode_Failure otherwise.
Header
ets_api_extd_attr.h
Details
If the default value is symbolic, it is looked-up and copied into symbol_buf_ptr. If the value is non-symbolic, a blank buffer is returned and a recoverable error is generated.