ENVIPreferences

This is a reference to a preference object that holds and manages ENVI preferences.

Example

; Launch ENVI

e = ENVI()

; Retrieve the ENVIPreferences object.

prefs = e.Preferences

; Retrieve the file where ENVI's preferences are stored.

prefFile = prefs.URI

; Print the ENVIPreferences object.

PRINT, prefs

; IDL will print the names and current values of all of ENVI's preferences.

Syntax

Result = ENVIPreferences([, Properties=value])

Methods

Load

RestoreDefaults

Save

Properties

Properties marked as (Get) can be retrieved, but not set.

URI (Get)

This is an application-wide file where ENVI loads and saves preferences. To load or save preferences to a different location after the application has been launched, use ENVIPreferences::Load or ENVIPreferences::Save. To save an individual preference, use ENVIPreferenceItem::Save. To override this property throughout the application, set the PREFERENCE keyword of ENVI function when launching ENVI.

Version History

ENVI 5.2

Introduced

API Version

4.2