The SaveSession method creates an ENVI session file that specifies a layout configuration, files loaded into views, and their properties. See Save and Restore Views and Layers for more information about what can be stored in a session file.

The session is saved to a JSON-format file (.json). You can view and edit this file using a text editor.


; Launch the application
e = ENVI()
; Open a raster file
file = FILEPATH('qb_boulder_pan', ROOT_DIR=e.ROOT_DIR, $
raster = e.OpenRaster(file)
; Create an empty view
view = e.GetView()
; Create a raster layer in the view
layer = view.CreateLayer(raster)
; Save the ENVI session
e.SaveSession, 'C:\Data\envi_session.json'


ENVI.SaveSession, Filename[, ERROR=variable]



Specify a fully qualified URI with the name and path of the output ENVI session file.


ERROR (optional)

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


API Version


See Also

ENVI function, ENVI::RestoreSession