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.
Header
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.