Ets_Obj_Attr_Desc_Basic_Get()
Abstract
Gets basic information about an attribute description.
Syntax
Ets_Obj_Attr_Desc_Basic_Get (attr_desc_model_hndl, comment_tlptr, default_value_ptr)
| Argument | Type | Description |
|---|---|---|
attr_desc_model_hndl |
EtsT_Model_Handle |
A handle to the attribute description model. |
comment_tlptr |
PrgT_List * |
A pointer to a list into which the comments of the attribute description will be written, or NIL. |
default_value_ptr |
void * |
A pointer to a variable into which the default value of the attribute description is written, or NIL. |
Return Type
void
No return value.
Header
ets_api_extd_attr.h
Details
This function retrieves basic information about the specified attribute description, namely its comments and its default value.
The default_value_ptr points to client data storage.
The default_value_ptr argument must point to a variable of the correct type, depending on the type of the attribute.
| If the attribute type is… | default_value_ptr must be… |
|---|---|
| int | int * |
| double | double * |
| string | char * |
| text list | PrgT_List * |
| compound attr obj | EtsT_Obj_Handle * |
| toggle | int * |
| typed file | char * |
| profile | PrgT_Profile_Spec * |
If the default value is symbolic, it is looked up. A non-symbolic value is returned.
If any parameter is PRGC_NIL, that parameter is not written to. This is useful if you want to get the comments, but don’t care about the default value, or vice-versa.