Ets_Obj_Extended_Attr_Desc_Basic_Set()
Abstract
Sets basic information about an attribute description.
Syntax
Ets_Obj_Extended_Attr_Desc_Basic_Set (attr_desc_model_hndl, comments_tlptr, ...)
| Argument | Type | Description |
|---|---|---|
attr_desc_model_hndl |
EtsT_Model_Handle |
A handle to the attribute description model. |
comments_tlptr |
PrgT_List * |
A pointer to a list of strings specifying the comments of the attribute. |
default_value |
see Details | The default value of the attribute; the type of this argument must correspond to the type of the attribute (see Table 32 Attribute–Type Correspondence). |
Return Type
void
No return value.
Header
ets_api_extd_attr.h
Details
This function sets basic information about the specified attribute description, namely its comments and its default value.
Both comments_tlptr and default_value must be non-NIL. To leave one of these fields unchanged, it is necessary to first call Ets_Obj_Attr_Desc_Basic_Get() to retrieve the previous value to pass to this function.
The third argument (default_value) must be a value of the correct type for the attribute:
Table 32: Attribute–Type Correspondence
| If the attribute type is… | default_value 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 |
Symbolic values cannot be specified.
The default value is not checked against the value bounds.
If the attribute description was previously public, calling this function makes it private, because its data is modified.