IDL Reference Guide: iTools Object Classes

IDLitDataContainer::GetData

The IDLitDataContainer::GetData function method retrieves the data value contained in the data object specified by the Identifier argument.

Syntax

Result = Obj->[IDLitDataContainer::]GetData(Data [, Identifier] [, /NO_COPY])

Return Value

Returns a 1 if the operation succeeds, and 0 if it fails.

Arguments

Data

A named variable that will contain the data value of the specified data object.

Identifier

A string containing the relative object identifier path to the target data object for this method. See iTool Object Identifiers for a discussion of object identifier strings.

If Identifier is not set. or is set to a null string, the data contained in the data container itself is returned.

Keywords

NO_COPY

Set this keyword to move the data from the data container object to the variable specified by the Data argument, leaving the data value of the data object undefined.

Version History

  IDL Online Help (March 06, 2007)