ENVITaskParameter::QueryProperty

This method has been deprecated.

The QueryProperty function returns information about the properties of the parameter. If called with no arguments, it returns a string array of all the property names. If called with a scalar string argument, it returns a Boolean value indicating whether the parameter supports a property of that name or not.

Example

This example defines an incorrect data type value for the RadiometricCalibration task, then shows how to validate the OUTPUT_DATA_TYPE property. Copy and paste the following code into the IDL command line:

; Start the application

e = ENVI()

 

; Get the radiometric calibration task from the catalog of ENVI tasks

task = ENVITask('RadiometricCalibration')

 

; Validate the OUTPUT_DATA_TYPE property to see if its value is valid,

; before running the task

param = task.Parameter('OUTPUT_DATA_TYPE') ; this is the ENVITaskParameter object

props = param.QueryProperty()

print, props

The result reported to the IDL console is 'NAME DISPLAY_NAME TYPE DESCRIPTION DIRECTION REQUIRED DEFAULT VALUE CHOICE_LIST FOLD_CASE'.

To determine if the parameter supports the CHOICE_LIST property:

result = param.QueryProperty('CHOICE_LIST')

print, result

The result reported to the IDL console is '1', indicating that this parameter does support the CHOICE_LIST property, which may have a !NULL value.

Syntax

Result = ENVITaskParameter.QueryProperty( [propertyIdentifier])

Arguments

propertyIdentifier

Optional scalar string indicating property name to test ownership of. If this argument is omitted, the function will return an array of all the property names for the parameter. If this argument is specified, the function will return a Boolean value indicating whether this parameter has a property with that name or not.

Keywords

none

Version History

ENVI 5.4	Introduced
ENVI 5.4.1	Deprecated

API Version

4.2

See Also

ENVITask, ENVITask::Validate, ENVITask::Parameter