Ets_Topo_Child_Get_By_Name()
Abstract
Returns a handle to the named child object of the specified type in the specified parent object.
Syntax
Ets_Topo_Child_Get_By_Name (parent_obj_hndl, child_type, child_name)
| Argument | Type | Description |
|---|---|---|
parent_obj_hndl |
EtsT_Obj_Handle |
Handle to parent object. |
child_type |
“EtsT_Obj_Type“ |
Value specifying the type or meta-type of child object (one of the values in Table 33 “General Sub-Package Symbolic Constants“ on page 1046). |
child_name |
const char * |
Name specifying which of the child objects to return. |
Return Type
EtsT_Obj_Handle
Handle to the child object.
Header
ets_api_topo.h
Details
When the parent object is a network subnet object, the children are the nodes, subnets, links, and annotations that reside directly in that subnet. When the parent object is a compound object, the children are the “rows” of that compound object.
The child_type argument can be either a specific object type (such as EtsC_Obj_Type_Node_Fix) or a general object meta-type (such as EtsC_Obj_Mtype_Link).
Paths have no children and do not belong to any subnet; hence this function returns an empty handle if parent_obj_hndl references a path object or child_type equals EtsC_Obj_Type_Path.
The child_name argument must be a non-NIL string that will be compared against the name attribute of each child object in turn (but in no specific order). The name attribute must match the search name exactly, including case. If multiple child objects have a matching name, then a handle to one will be returned, but which one is unspecified.