IDLitData::GetData

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitData::GetData function method retrieves the data stored in the object.

Syntax

Result = Obj->[IDLitData::]GetData(Data[, Identifier] [, NAN=variable] [, /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 retrieved from the data object. If the GetData method fails, the variable is not modified.

Identifier

A string argument that is not used by this method, but is accepted for parameter compatibility with the IDLitDataContainer::GetData method. If a value for this argument is supplied, the method does not retrieve any data and returns the value 0.

Keywords

NAN

Set this keyword to a named variable that will contain 1 if Data contains any non-finite values (either NaN or Infinity), or 0 otherwise.

NO_COPY

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

Version History