ENVI::CleanupTemporaryWorkspace

The CleanupTemporaryWorkspace method attempts to delete all of the files in the Temporary Workspace. This is a subdirectory within the Temporary Directory that contains the name ENVI_Session_. ENVI tries to put most of the temporary files created during a session in the Temporary Workspace. ENVI will first close any items contained in the Data Manager before deleting the files in the Temporary Workspace.

Syntax

ENVI.CleanupTemporaryWorkspace [, 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.5.3

Introduced

API Version