Runtime.GetRetrievableObject

Prototypes

static Object GetRetrievableObject()

Return Value

The return value is a reference to the object most recently passed to the method Runtime.SetRetrievableObject. If there is no object to retrieve, the return value is null.

Parameters

None

Remarks

This method returns a reference to the object most recently passed to the method Runtime.SetRetrievableObject. The method GetRetrievableObject clears the retrievable object memory. If your program calls GetRetrievableObject a second time, the return value will be null.

Notes

The Runtime class can only remember one retrievable object at a time. It cannot remember multiple objects of different types.
The methods Runtime.GetRetrievableObject and Runtime.SetRetrievableObject do not make copies of an object. They only manipulate references to the object.

Example

start CreatePlot( x, y );
    declare ScatterPlot plot;
    plot = ScatterPlot.Create( "Example", x, y );
    Runtime.SetRetrievableObject( plot );
finish;

x = 1:10;
y = 1:10;
run CreatePlot( x, y );
declare Plot plot = Runtime.GetRetrievableObject();
plot.ShowReferenceLines();