IDLitData::SetData

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitData::SetData function method copies the data from an IDL variable or expression into the data object, and notifies all its observers that the data has changed.

Syntax

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

Return Value

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

Arguments

Data

An IDL variable or expression whose value is copied into the data object.

Identifier

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

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.

Version History