Ets_Nt_Object_Overlay_Icon_Name_Get()
Note: Requires OPNET Development Kit
Abstract
Returns the name of any temporary overlay icon that is currently active for the specified object.
Syntax
Ets_Nt_Object_Overlay_Icon_Name_Get (obj_hndl, overlay_icon_name)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Handle to the object of interest. Object must be a site (node or subnet), link, path, or demand. |
overlay_icon_name |
char * |
Pointer to a string buffer to be filled with the name of the icon currently overlaying the specified object. The buffer is left empty if there is no overlay icon. |
Return Type
EtsT_Compcode
EtsC_Compcode_Failure if the object is not a supported type; EtsC_Compcode_Success otherwise.
Header
ets_api_nt.h