Reserved Variable Return Values

The following list the values returned for reserved variables and various step types:

Step Type st_LastReturn Value st_LastError st_LastValidation st_RepeatListValue
<<Start>> True

Unchanged

Unchanged

Unchanged

<<End>> True n/a n/a n/a
Automation steps

The return value of the Open Agent method.

Contains any error message that the method sets.

Unchanged

Unchanged

Playback Visual Test

True = visual test is executed.

False = visual test is not executed.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Verify

Returns the result of the last verification logic performed.

True = successful verification of most recent.

False = failed verification of most recent.

This may contain an error message if the evaluated expression fails, e.g., referencing a variable that no longer exists.

Unchanged

Unchanged

Get contents of global variable

True = retrieved variable contents.

False = contents are not retrieved.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Set global variable

True = variable content is set.

False = variable content is not set.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Get playback setting

True = playback setting is put into a local variable.

False = playback setting failed to be put into a local variable.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Set playback setting...

True = playback setting is set.

False = playback setting is not set.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Run program

The return values of the ShellExecute API function (greater than 32 is success).

This is similar to the VBA Shell() function.

st_LastReturnValue > 32 - Empty

st_LastReturnValue <= 32 - Contains the error message returned from Windows, e.g., for 2 the message would be "The system could not find the file specified."

Unchanged

Unchanged

Message box

The number of the button that was pressed (Long):

1 = OK

2 = Cancel

3 = Abort

4 = Retry

5 = Ignore

6 = Yes

7 = No

This can contain an error message if the evaluated expression fails, e.g., referencing a variable that no longer exists.

Unchanged

Unchanged

Start timer

True = timer is being started.

False = timer has already been started.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Resume timer

True = timer is being resumed after a Stop timer.

False = timer is already running.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Reset timer True Empty

Unchanged

Unchanged

Stop timer

The elapsed time on the specified timer in milliseconds (Long).

False (Boolean) if the timer was not started.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Delay True Empty

Unchanged

Unchanged

Go to label [label name]

True = step executed.

False = step did not execute.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

On error

True = step executed.

False = step did not execute.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Result Comment

True = step executed.

False = step did not execute.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Using [locator name] (screen step)

True = step executed.

False = step did not execute.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Corrupt item placeholder False Empty

Unchanged

Unchanged

Logic - If/ElseIf/Else/EndIf

Unchanged

This may contain an error message if the evaluated expression fails, e.g., referencing a variable that no longer exists.

Unchanged

Unchanged

Loop - Repeat/EndRepeat

Unchanged

This may contain an error message if the evaluated expression fails, e.g., referencing a variable that no longer exists.

Unchanged

Unchanged when a loop does not iterate the contents of list controls.

When the loop iterates the contents of list type controls this contains both the index and value of the item as a compound value (represented as a formatting string in a visual test).

Stop True Empty

Unchanged

Unchanged

Label

Unchanged

Unchanged

Unchanged

Unchanged

Property from Control

True = found control and the variable set correctly.

False = an error occurred, e.g., the control could not be found or the target variable was not found.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Is always set to the value of the property (even if no local variable is specified).
Get contents of eCATT argument True if the argument contents are retrieved, false if the contents are not retrieved.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged

Set eCATT argument True if the argument content is set, false if it is not.

st_LastReturnValue = True - Empty.

st_LastReturnValue = False - Contains an error message.

Unchanged

Unchanged