oid_get_icon
oid_get_icon (oid[, index])
This function returns the name of the display icon that appears to the left of the specified
oid. The icons appear in the Document Map and also appear in the Edit window. However, whether the icons appear in the Edit window is dependent on the settings of the
set showiconsfulltags,
set showiconspartialtags, and
set showiconsnotags commands. A list of returnable icon names is available in the help topic for the
oid_set_icon function.
An element can have one or two icons associated with it through oid_set_icon. The index parameter may be set to 1 or 2 to retrieve the first or second icon, respectively. If index is omitted, then the first icon is returned.
If the specified oid does not have the specified icon, index is something other than 1 or 2, or oid is invalid, the function returns the string None.
The following example gets the icon for the oid to the left of the cursor:
$icontype = oid_get_icon(oid_current_tag())
Related Topics