hiSetIconName

hiSetIconName(
w_windowId 
t_iconName 
) 
=> t / nil 

Description

Sets the name that is displayed on a window’s icon when the window is minimized. A session window, when minimized, displays the icon name of the window that is currently active within it; if the window does not have an icon name set, then the session window’s icon name is displayed.

This function is not available in Concept SKILL. Additionally, the function has no effect for KDE or GNOME version 3. For more information, see Design Entry HDL–SKILL Routines.

Arguments

w_windowId	The ID of the window, session window, or dockable window.
t_iconName	The name that is to be displayed on the window’s icon. Only the first six or seven characters of the icon name are visible because of the icon size.

Value Returned

t	The icon name is set.
nil	w_windowId is invalid.

Related Topics

Window Functions

hiGetIconName

hiSetWindowIcon

Return to top