hiGetWindowList

hiGetWindowList(
[ s_windowType ]
) 
=> l_windowId 

Description

Returns a list of window IDs of all windows that have been created but not closed, including those that are not currently displayed. You can specify the type of window with the s_windowType argument. By default, all windows except session windows and dock windows are returned.

The Command Interpreter Window is always included in this list.

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

Argument

s_windowType

Specifies one of the following symbols: ’all: Returns all windows including session windows and dockable windows ’session: Returns all session windows ’dockable: Returns all dockable windows ’window: Returns all windows except session windows and dockable windows Default value: ’window

Values Returned

l_windowId

A list of window IDs.

Examples

Returns a list of all the active windows excluding session and dockable windows.

hiGetWindowList( )
=> (window:1 window:2 window:3)

hiGetWindowList(’window)
=> (window:1 window:2 window:3)

Returns a list of all the active session windows.

hiGetWindowList(’session)
=> (swindow:1 swindow:2)

Returns a list of all the active dockable windows.

hiGetWindowList(’dockable)
=>(dwindow:1 dwindow:3 dwindow:4)

Returns a list of all the active windows.

hiGetWindowList(’all)

=> (window:1 window:2 window:3 swindow:1 dwindow:1 dwindow:3 swindow:2 dwindow:4)

Related Topics

Window Functions

Return to top