IDLitParameterSet::GetByName

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitParameterSet::GetByName function method returns the IDLitData object associated with a specified named parameter.

Syntax

Result = Obj->[IDLitParameterSet::]GetByName( Names [, COUNT=variable] [, NAME=variable] )

Return Value

An object reference or array of object references to the IDLitData objects specified by the Names argument. If no matching parameter names are found, a null object is returned.

Note
If multiple parameter names are specified, the IDLitData objects are returned in the order in which they are stored in the IDLitParameterSet object, which is not necessarily the same as the order specified in the Names argument. Use the value returned by the NAME keyword to associate the parameter names with IDLitData objects in the returned array.

Arguments

Names

A scalar string or string array that contains the parameter names of the IDLitData objects to be retrieved from the parameter set.

Note
Parameter names can be supplied in any case; the search is case insensitive.

Keywords

COUNT

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

NAME

Set this keyword equal to a named variable that will contain a scalar string or string array of the parameter names of the IDLitData objects returned by this method. When multiple parameter names are specified via the Names argument, the array returned in the NAME variable can be used to sort through the returned IDLitData objects by matching the indices of the two returned arrays.

Version History