IDLitDataContainer::SetData

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitDataContainer::SetData function method stores data in the IDLitData object specified by Identifier. This method acts in exactly the same way as the IDLitData::SetData method.

Syntax

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

Return Value

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

Arguments

Data

An IDL variable of any type that is copied into the specified data object.

Identifier

A scalar string containing the object identifier of the IDLitData object in which the data specified by Data should be stored. This path must specify a valid IDLitData object, or the function fails. See iTool Object Identifiers (iTool Developer's Guide) for a discussion of object identifier strings.

Keywords

NO_COPY

Set this keyword to move the data into the specified IDLitData object without creating an additional copy. This leaves the original IDL variable named by the Data argument undefined.

NULL

Set this keyword to remove any data stored in the IDLitData object, leaving it empty. If this keyword is set, the Data argument is ignored, but must still be present.

Version History