The Dehydrate function method transforms the current parameter instance into a Hash containing keys to describe each of its properties. Any property that must conform to the TYPE property will be itself dehydrated by the Dehydrate function to ensure they are reduced to primitive form. The return value can be passed into the Hydrate function to clone the parameter instance, or it can be serialized for storage or transmission. For additional information, see What are Hydrate and Dehydrate routines used for?
Syntax
Result = ENVIParameterENVITrainer.Dehydrate([ERROR=variable])
Return Value
The result is a hash comprised of ENVI primitive values that describes this parameter and all its properties.
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
API Version
4.2
See Also
ENVIParameterENVITrainer