ENVIDataContainer::RemoveArray

Use the RemoveArray method to remove all data objects (for example, rasters, vectors, strings) from a data container array.

Example

; Start the application

e = ENVI(/HEADLESS)

; Create a data container

container = ENVIDataContainer()

; Open a raster file

File = Filepath('qb_boulder_msi', Root_Dir=e.Root_Dir, $

  Subdir = ['data'])

Raster = e.OpenRaster(File)

; Open a vector file

VectorFile = Filepath('qb_boulder_msi_vectors.shp', $

  Root_Dir=e.Root_Dir, Subdir = ['data'])

Vector = e.OpenVector(VectorFile)

; Create an array for the data container

; and add the raster and vector to the array

container.AddArray, 'MyContainer', Raster

container.AddArray, 'MyContainer', Vector

; Remove all data objects from the array

container.RemoveArray, 'MyContainer'

Syntax

ENVIDataContainer.RemoveArray, Key [, ERROR=value]

Arguments

Key

Specify a string identifier with the array name from which to remove data objects.

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

Introduced

API Version

4.2