IGETPROPERTY

The IGETPROPERTY procedure retrieves a property value from an iTool object.

Note
The keyword name used to get the property may not be the same as the human-readable name displayed on the property sheet.

This routine is written in the IDL language. Its source code can be found in the file igetproperty.pro in the lib/itools subdirectory of the IDL distribution.

For more information about iTool properties, see "About the Properties Interface" (iTool Developer's Guide).

Syntax

IGETPROPERTY, ID [, PROPERTY=value] [, _REGISTERED=array] [, TOOL=iToolID]

Arguments

ID

A string containing the identifier of the iTools object from which to retrieve the property value. If you pass a partial identifier, the IGETID function is called to retrieve the full identifier string.

Keywords

To retrieve the value of a property, specify the property name as a keyword set equal to a named variable that will contain the value of the property.

_REGISTERED

Set this keyword to a named variable that will contain a list of all registered properties of the iTool object.

TOOL

Set this keyword to a string specifying one or more iTools in which to search for Id. If this keyword is not set, only the current iTool is searched.

Examples

See the example for ISETPROPERTY.

Version History


7.1	Introduced