Ets_Obj_Attr_Intended_Status_Get()
Abstract
Returns whether or not the status of an object attribute is Intended.
Syntax
Ets_Obj_Attr_Intended_Status_Get (obj_hndl, attr_name)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Handle of the object of interest. |
attr_name |
const char * |
Name of the attribute of interest. |
Return Type
EtsT_Boolean
EtsC_True if the specified attribute exists and its status is Intended; EtsC_False otherwise.
Header
ets_api_obj.h
Details
Attribute values set by the user at the network level (for example, via the Edit Attributes dialog box or a Device Configuration Import) are “intended” and are saved with the network model. Those attributes that are not “intended” get their values from the model (node, link, and so on) that the particular object represents. If this underlying model does not “intend” the attributes itself, the unintended attributes get their values from the process models.
Ets_Obj_Attr_Intended_Status_Get() looks only at the network-intended status. If an attribute is different from default (node-intended), but not explicitly set by the user, this function will return EtsC_False.