IDL Reference Guide: iTools Object Classes

IDLitParameter::GetParameterAttribute

The IDLitParameter::GetParameterAttribute procedure method retrieves one or more parameter attributes for a registered parameter.

Syntax

Obj->[IDLitParameter::]GetParameterAttribute(ParamName [, BY_VALUE=variable] [, DESCRIPTION=variable] [, INPUT=variable] [, OPTARGET=variable] [, OPTIONAL=variable] [, OUTPUT=variable] [, TYPES=variable] )

Arguments

ParamName

A scalar string or string array containing names of registered parameters.

Keywords

BY_VALUE

Set this keyword equal to a named variable that will contain a 1 (one) if ParamName is marked as being a by-value parameter, or a 0 (zero) if ParamName is marked as being a by-reference parameter.

DESCRIPTION

Set this keyword equal to a named variable that will contain the full name or description of this object.

INPUT

Set this keyword equal to a named variable that will contain a 1 (one) if ParamName is an input parameter, or a 0 (zero) otherwise.

OPTARGET

Set this keyword equal to a named variable that will contain a 1 (one) if ParamName may be the target of any operations, or a 0 (zero) otherwise.

OPTIONAL

Set this keyword equal to a named variable that will contain a 1 (one) if ParamName is an optional parameter, or a 0 (zero) otherwise.

OUTPUT

Set this keyword equal to a named variable that will contain a 1 (one) if ParamName is an output parameter, or a 0 (zero) otherwise.

TYPES

Set this keyword equal to a named variable that will contain a scalar string or string array giving the data types that correspond to this parameter. See iTool Data Types for more on parameter data types.

Example

This example creates an iPlot tool and retrieves the description attribute of the registered parameter named "vertices":

IPLOT, RANDOMU(seed, 15)  
idTool = ITGETCURRENT(TOOL=otool)  
idPlot = oTool->FindIdentifiers('*plot*', /VISUALIZATIONS)  
oPlot = oTool->GetByIdentifier(idPlot)  
oPlot->GetParameterAttribute, 'vertices', DESCRIPTION=desc  
PRINT, desc  

IDL prints:

Vertex Data