ENVIParameterUI::GetValue

The GetValue method returns the current value of the UI element as defined by the user.

Example

See Custom UI Class Example: Present Multiple Output Options in One Step.

Syntax

Result = ENVIParameterUI.GetValue([ERROR=value])

Return Value

This method returns the current value of the UI element as defined by the user.

Arguments

None

Keywords

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

Introduced

API Version

4.2