Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiGetIconName

hiGetIconName(
w_windowId 
) 
=> t_iconName / nil

Description

Gets the name that is displayed on a window icon when the window is minimized. This name is set with the hiSetIconName function.

A session window, when minimized, displays the icon name of the window that is currently active within it, unless it is not set, in which case it displays the session window icon name. This function, however, always returns the session icon name when passed a session window.

This function is not available in Concept SKILL. For more information, see Design Entry HDL–SKILL Routines.

Argument

w_windowId

The ID of the window, session window, or dockable window.

Value Returned

t_iconName

The icon name.

nil

The window is invalid or an icon name has not been set for it.

Related Topics

Window Functions

hiSetIconName

hiSetWindowIcon


Return to top
 ⠀
X