hiGetWindowState

hiGetWindowState(
w_windowId
) 
=> s_state / nil

Description

Returns the display state of a window: mapped, unmapped, or iconified.

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

s_state	Returns one of the following symbols: mapped, unmapped, or iconified.
nil	The window, or the session window that contains it, has not been displayed yet with hiDisplayWindow. If w_windowID is a session window, the session window, or any window it contains, has not been displayed yet.

Example

Returns the display state of the win3 window.

hiGetWindowState( win3 )
=> unmapped

Returns the display state of the sessionWin window.

hiGetWIndowState( sessionWin )
=> mapped

Related Topics

Window Functions

hiGetWindowDisplayState

Return to top