GETWINDOWS

The GETWINDOWS function retrieves either a specific graphic window or all graphics windows.

Example

p = PLOT(/TEST)

c = CONTOUR(/TEST)

pwin = GetWindows('Plot')

HELP, pwin

win = GetWindows(NAMES=winNames)

HELP, win

PRINT, winNames

When this example is run, IDL prints:

PWIN            OBJREF    = Array[1]

WIN             OBJREF    = Array[2]

Plot Contour

Syntax

Result = GETWINDOWS( [Name] [, /CURRENT] [, NAMES=variable] )

Return Value

The result is a scalar or array of graphics windows, or a null object if no graphics windows exist.

Arguments

Name

Set this optional argument to a string giving the name of the window to retrieve. The first window whose NAME property matches Name will be returned. If no window exists with that name then a null object is returned.

Keywords

Keywords are applied only during the initial creation of the graphic.

CURRENT

If this keyword is set, then return only the current graphics window or a null object if no graphics windows exist. The SetCurrent Method may be used to change the current window.

NAMES

Set this keyword to a named variable in which to return a scalar string or a string array of the window names in Result.

Version History

8.0	Introduced
8.2	Added CURRENT keyword.