Ets_Nt_Object_Overlay_Icon_Name_Set()
Note: Requires OPNET Development Kit
Abstract
Temporarily overlays an object in the Project Editor workspace with the specified icon.
Syntax
Ets_Nt_Object_Overlay_Icon_Name_Set (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 |
const char * |
Pointer to a string buffer containing the name of an icon with which to overlay the specified object. If NIL or an empty string is passed, no overlay icon is kept for the object. |
Return Type
EtsT_Compcode
EtsC_Compcode_Failure if the object is not a supported type; EtsC_Compcode_Success otherwise.
Header
ets_api_nt.h
Details
The overlay icon is provided for transitory annotation only and is not saved to file. If there is a link inconsistency message attached to a link object, this icon will override the inconsistency icon, but the inconsistency message will still appear if the overlay icon is clicked.