Ets_Obj_Hname_Get()

Abstract

Returns the hierarchical name of the specified object.

Syntax

Ets_Obj_Hname_Get (obj_hndl, include_top)
Argument Type Description
obj_hndl EtsT_Obj_Handle Handle of the object of interest.
include_top EtsT_Boolean Indicates whether the returned name should include “top” (that is, be of the form “top.<...>.node”).

Return Type

char *

A valid hierarchical name for the object, or PRGC_NIL.

ets_api_obj.h

Details

This function returns a newly-allocated string with the hierarchical name (hname) of the object specified by obj_hndl. If include_top is true, the hname will be of the form top.subnet_1.<...>.node; otherwise, the hname will be of the form subnet_1.<...>.node. If the object specified by obj_hndl is not valid or not installed in a model, or if the name attribute does not exist for any of obj_hndl’s parent objects, PRGC_NIL is returned.

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