ENVIRasterIterator::Reset

The Reset method resets the iterator to the beginning of the tile list. After calling this method, use ENVIRasterIterator::Next to retrieve the data for the first tile.

Example

See the example for ENVIRasterIterator::GetData.

Syntax

ENVIRasterIterator.Reset [, Keywords=value]

Keywords

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

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.

LAST

Set this keyword to reset the iterator to the end of the tiles list so that the tiles may be iterated over in reverse order. After this method is called, you may retrieve the data of the last tile by calling ENVIRasterIterator::Previous.

Version History

ENVI 5

Introduced

API Version

4.2