Ets_Obj_Attr_Symbolic_Only()
Abstract
Indicates whether a given attribute with a symbol map can take custom and symbolic or only symbolic values.
Syntax
Ets_Obj_Attr_Symbolic_Only (obj_hndl, attr_name, is_sym_only_ptr)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Handle to an object containing the attribute of interest. |
attr_name |
const char * |
Name of attribute of interest. |
is_sym_only_ptr |
EtsT_Boolean * |
Boolean into which the result will be placed. |
Return Type
EtsT_Compcode
Indicates whether the function completed successfully on the given arguments.
Header
ets_api_obj.h
Details
This function determines whether an attribute allows only symbolic values, or if it allows symbolic and “other” user-entered values.
The boolean referenced by is_sym_only_ptr is set to an EtsT_Boolean value indicating whether the attribute of interest is symbolic only. If it is only symbolic, the value is EtsC_True; otherwise, EtsC_False.