Welcome to the Harris Geospatial documentation center. Here you will find reference guides and help documents.


  >  Docs Center  >  ENVI API  >  Data Control  >  ENVIROI::Close

ENVIROI::Close

ENVIROI::Close

The method closes the ENVIROI for reading and removes any layers displaying it.

Example


; Launch the application
e = ENVI()
 
; Open the input file
file = Filepath('qb_boulder_msi', ROOT_DIR=e.Root_Dir, $
  SUBDIRECTORY=['data'])
raster = e.OpenRaster(file)
view = e.GetView()
layer = view.CreateLayer(raster)
 
; Qpen and display the associated ROIs
file = Filepath('qb_boulder_roi.xml', ROOT_DIR=e.Root_Dir, $
  SUBDIRECTORY=['data'])
rois = e.OpenRoi(file)
numRois = N_Elements(rois)
roiLayers = Objarr(numRois)
FOR i=0, N_Elements(rois)-1 DO $
  roiLayers[i] = layer.AddRoi(rois[i])
 
; Close the ROIs
rois[1].Close

Syntax


ENVIROI.Close [, ERROR=variable]

Keywords


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


3.3

See Also


ENVIROI, ENVIROILayer



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us