Ets_Site_Display_Icon_Name_Get()
Abstract
Gets the name of the temporary icon being used to draw a site.
Syntax
Ets_Site_Display_Icon_Name_Get (obj_hndl, icon_name)
| Argument | Type | Description |
|---|---|---|
obj_hndl |
EtsT_Obj_Handle |
Site for which to get the icon name. |
icon_name |
char * |
Area to be filled with the icon name. |
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 find the name of the temporary display icon being used to draw a site (as set by Ets_Site_Display_Icon_Name_Set()). If the function sets icon_name to an empty string, no display icon has been set and the icon is specified by the site’s “icon name” attribute.