IDL Reference Guide: iTools Object Classes

IDLitParameterSet::GetParameterName

The IDLitParameterSet::GetParameterName function method retrieves the name of a specified parameter using a provided data object.

Syntax

Result = Obj->[IDLitParameterSet::]GetParameterName(Data, Name)

Return Value

Returns an integer 1 if a parameter name was found for the specified IDLitData object, or 0 if no parameter name was found.

Arguments

Data

An IDLitData object for which the parameter name is being requested.

Name

A named variable that will contain the parameter name associated with the object specified by the oData argument. If no parameter name is associated with the object specified by the oData argument, a null string ('') is returned.

Keywords

None

Version History

  IDL Online Help (March 06, 2007)