Runtime.GetRetrievableString

Prototypes

static String GetRetrievableString()

Return Value

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

Parameters

None

Remarks

This method returns a reference to the String object most recently passed to the method Runtime.SetRetrievableString. The method GetRetrievableString clears the retrievable object memory. If your program calls GetRetrievableString 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.GetRetrievableString and Runtime.SetRetrievableString do not make copies of a String object. They only manipulate references to the object.

Example

start PerformCalculation( x, y );
    Runtime.SetRetrievableString( "Note: calculation is multiplication" );
    return x * y;
finish;

x = 2;
y = 5;
z = PerformCalculation( x, y );
print z;
print (Runtime.GetRetrievableString());