hiGetWindowIconifyState

hiGetWindowIconifyState( 
w_windowId 
)
=> l_iconPosition / nil

Description

Returns the icon position of an iconified window. If the window is contained in a session window, this function returns the icon position of the session window.

w_windowId can also be a session window; it cannot be a dock window.

To ensure that a restored window is in the correct icon state when a saved session is restored, you must pass the value returned by this function as the l_iconPosition argument of the function hiOpenWindow or hiCreateWindow when you log these functions to the save/restore file.

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

Argument

w_windowId

ID of the window for which you need the icon position. The window can be a session window but it cannot be a dock window.

Value Returned

l_iconPosition	The icon position (a list of the x and y coordinates) of the iconified window. The x and y coordinates correspond to the upper-left corner of the icon (0:0 is the upper-left corner of the screen).
nil	The window is not iconified.

Related Topics

Related Topics

Window Functions

hiOpenWindow

hiUndockWindow

hiIconifyWindow

hiDeiconifyWindow

Return to top