Ets_Site_Display_Icon_Name_Set()
Abstract
Temporarily changes the icon used to draw a site.
Syntax
Ets_Site_Display_Icon_Name_Set (obj_hndl, icon_name)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Site for which to temporarily change the icon. |
icon_name |
const char * |
Name of the icon to use. |
Return Type
EtsT_Compcode
EtsC_Compcode_Failure if the object is not a site; EtsC_Compcode_Success otherwise.
Header
ets_api_nt.h
Details
This function lets you temporarily override a site’s regular icon. When this function is called, Modeler will use icon_name whenever the specified site is drawn. The new display icon is not saved with the network, so you will need to reset this value every time the project is reopened.
To remove a temporary icon, set the icon_name to NULL.
To permanently change the icon, change the value of the site’s “icon name” attribute.