Ets_Topo_Assoc_Get()

Abstract

Returns a handle to the indexed object of the specified type associated with the reference object in the specified direction.

Syntax

Ets_Topo_Assoc_Get (reference_obj_hndl, dir, assoc_mtype, assoc_obj_index)
Argument Type Description
reference_obj_hndl EtsT_Obj_Handle Handle to reference object.
dir EtsT_Topo_Assoc_Dir Value specifying the direction of association (see possible values in Topology Package Symbolic Constants).
assoc_mtype “EtsT_Obj_Type“ Value specifying the type or meta-type of associated objects (one of the values in Table 33 “General Sub-Package Symbolic Constants“ on page 1046).
assoc_obj_index int Index specifying which of the associated objects to return.

Return Type

EtsT_Obj_Handle

Handle to the object associated to the reference object in specified direction, or NULL if none.

ets_api_topo.h

Details

This function returns a handle to an object associated with the specified reference object (see Associations for a description of how associations are determined). It returns NULL if there is no associated object that meets the requirements (for example, a point demand might not have a destination).

The assoc_mtype argument can be either a specific object type (e.g., EtsC_Obj_Type_Node_Fix) or a general object meta-type (for example, EtsC_Obj_Mtype_Link).

The assoc_obj_index argument must be a value between zero (inclusive) and the count (exclusive) returned by Ets_Topo_Assoc_Count_Get(), when called with the same reference object and the same object type.

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · 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