Ets_Obj_Comp_Attr_Desc_Get()
Abstract
Gets the attribute descriptions of a compound attribute.
Syntax
Ets_Obj_Comp_Attr_Desc_Get (attr_desc_model_hndl, count_attr_desc_model_hndl_ptr, obj_list_attr_desc_model_hndl_lptr, obj_list_attr_names_lptr)
| Argument | Type | Description |
|---|---|---|
attr_desc_model_hndl |
EtsT_Model_Handle |
Handle of the compound attribute model of interest |
count_attr_desc_mdl_hndl_ptr |
EtsT_Model_Handle * |
See Details |
obj_list_attr_desc_model_hndl_lptr |
PrgT_List * |
Empty list to be filled with elements of type EtsT_Model_Hndl* |
obj_list_attr_names_lptr |
PrgT_List * |
Empty list to be filled with elements of type const char* |
Return Type
void
No return value.
Header
ets_api_extd_attr.h
Details
Extracts information about the given compound attribute description model and returns a copy of the count attribute in count_attr_desc_model_hndl_ptr. Returns copies of the compound attribute’s attribute descriptions and names in obj_list_attr_desc_model_hndl_lptr and obj_list_attr_names_lptr, respectively.
The lists of attribute descriptions and names must be empty lists when passed into the function.
Use Ets_Obj_Extended_Comp_Attr_Desc_Set() to set these values on a compound attribute.
Important
- When setting up the value of a compound attribute object, you should add the sub-attributes first, before modifying the compound attribute’s count.
- To add sub-attributes to a compound attribute, modify the attribute description model’s obj_list attribute description by using the
Ets_Obj_Extended_Comp_Attr_Desc_Set()function.