ENVIPreferences::Load

The Load method loads preferences from the JSON file specified by the ENVIPreferences URI property.

Example

; Launch ENVI

e = ENVI()

; Now specify another preferences JSON file.

prefFile = DIALOG_PICKFILE()

; Load the new preferences

prefs = e.Preferences

prefs.Load, URI=prefFile

Syntax

ENVIPreferences.Load [, Keywords=value]

Arguments

None.

Keywords

URI

Set this keyword to the URI of an ENVI preferences JSON file to load. If this keyword is not specified, preferences will be loaded from the ENVI preference file specified by the ENVIPreferences URI property.

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

Introduced

API Version

4.2