IDL Reference Guide: iTools Object Classes

IDLitParameter::GetParameter

The IDLitParameter::GetParameter function method retrieves the IDLitData object associated with a registered parameter.

Syntax

Result = Obj->[IDLitParameter::]GetParameter(Name [, /ALL] [, COUNT=variable] )

Return Value

Returns an object reference to the IDLitData object associated with the specified parameter name, or a null object reference if no data objects are associated with the specified parameter name.

Arguments

Name

A scalar string containing the parameter name associated with the IDLitData object to be retrieved.

Keywords

ALL

Set this keyword to retrieve all of the IDLitData objects contained in the visualization object's IDLitParameterSet object.

COUNT

Set this keyword equal to a named variable that will contain the number of items returned by this function.

Version History

  IDL Online Help (March 06, 2007)