ENVIRasterLayer::GetLayer

The GetLayer function method returns the top-most ENVIROILayer.

Syntax

Result = ENVIRasterLayer.GetLayer([, /ALL] [, ERROR=variable])

Return Value

The default behavior for this method is to return the top-most ROI layer (ENVIROILayer).

Keywords

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

ALL

When this keyword is set, the method returns an array of all ENVIROILayers in top-down order (as they are listed in the Layer Manager).

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.1

Introduced

API Version

4.2