Ets_Topo_Parent_Get()

Abstract

Returns a handle to the parent object of the specified child object.

Syntax

Ets_Topo_Parent_Get (child_obj_hndl)
Argument Type Description
child_obj_hndl EtsT_Obj_Handle Handle to child object.

Return Type

EtsT_Obj_Handle

Handle to the parent object, if any.

ets_api_topo.h

Details

If the specified object does not have a parent or if the parent object cannot be determined, this function will return an invalid object handle. Ets_Obj_Invalid() on page 1026 can be used to test for this return value.

When given a top-level attribute, this function returns a pointer to the parent object’s related structure rather than to the object itself.

Note: If you are using this function in conjunction with Ets_Obj_Attr_Get() on a top-level attribute and will be using active attributes, you should use Ets_Topo_Parent_Attr_Get() instead of the Ets_Topo_Parent_Get() / Ets_Obj_Attr_Get() combination.

For network objects such as nodes, subnets, links, and annotations, the parent object is the subnet into which the object was installed. All of these objects have a parent object, except for the top subnet.

Paths have no parents; hence this function returns an empty handle if child_obj_hndl references a path object.

In general, child objects of compound objects do not keep track of their parent object, so this function will not succeed. However, if the child object was passed as the object being edited to a callback for the Edit Attributes dialog box, this function will return the object being edited at the next higher level and further up the network hierarchy.

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com