The Hydrate static function method takes in a Hash of ENVI primitive values and builds a new instance of this parameter class using all the dehydrated properties. It expects all property values to be properly dehydrated. This allows you to dehydrate a parameter and store the primitives, then restore it in a later session. For additional information, see What are Hydrate and Dehydrate routines used for?


Result = ENVIParameterENVIRasterMetadataArray.Hydrate(dehydratedForm [, ERROR=variable])

Return Value

The result is a reference to a new instance of this parameter class.



The Hash of ENVI primitive values describing all of this parameter's properties in dehydrated form, to be transformed into a new instance of this parameter class.


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


API Version


See Also