ENVI::GetView

The GetView function method returns the currently selected ENVIView reference.

Example

; Launch the application

e = ENVI()

; Get the first view

view = e.GetView()

; Create a second View

view2 = e.CreateView()

; Get the current active view

active_view = e.GetView()

; The second view should equal the active view

IF view2 EQ active_view THEN $

  PRINT, 'The second view is the active view.'

Syntax

Result = ENVI.GetView([/ALL] [, ERROR=variable])

Return Value

This method returns a reference to an ENVIView.

Keywords

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

ALL

When this keyword is set, the method returns all views.

ERROR

Set this keyword to a named variable that will contain any error message issued during execution of this routine. If no error occurs, the ERROR variable will be set to a null string (''). If an error occurs and the routine is a function, then the function result will be undefined.

When this keyword is not set and an error occurs, ENVI returns to the caller and execution halts. In this case, the error message is contained within !ERROR_STATE and can be caught using IDL's CATCH routine. See IDL Help for more information on !ERROR_STATE and CATCH.

See Manage Errors for more information on error handling in ENVI programming.

Version History

ENVI 5

Introduced

API Version

4.2