Screen.Return

Screen.Return ( 

number ReturnCode )

Description

Sets the return value of a screen. The return value of a screen is the value that is returned by Screen.Show.

Note: This action will cause the current script to end, so any actions after it will not be executed.

Parameters

ReturnCode

(number) The return code you want to set for the screen. Generally this should be one of the constants below (but doesn't have to be):

CONSTANT

VALUE

DESCRIPTION

SR_NEXT

0

This code can be used to identify that the screen was successful. Normally this can be found on the On Next event of a screen.

SR_PREV

1

This code can be used to identify that the user pressed the Back button on a screen. Normally this can be found on the On Back event of a screen.

SR_CANCEL

2

This code can be used to identify that the user clicked the Cancel button on a screen, or closed the screen. Normally this can be found on the On Cancel event of a screen.

SR_FAIL

3

This code can be used to identify that the screen failed in some way.

SR_SUCCESS

4

This code can be used to identify that the screen succeeded.

Returns

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

See also:  Related Actions