OverviewExamples
Shows the screens of a given screen list and returns the list's return code. Return codes can be generated from a screen using the Screen.Return action or the Screen.Next action. You can also specify the first screen to show in the given list.
Note: Since only one screen list can be shown at a time, this action can only be called from a script tab. Using this action on a screen event will result in an error.
(string) The name of the screen list you want to show.
(string) The first screen in the specified list you want to show. Leave this parameter blank ("") if you want to show the first screen in the screen list.
(number) The numeric return code of the specified screen. A return code can be any value set through the Screen.Return or Screen.Next action, however normally one of the following values are returned:
|
CONSTANT |
VALUE |
DESCRIPTION |
|
SR_NEXT |
0 |
This code is normally 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 is normally 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 is normally 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 is normally used to identify that the screen failed in some way. |
|
SR_SUCCESS |
4 |
This code can be used to identify that the screen succeeded. |
|
SR_LISTCOMPLETE |
10 |
This code is returned by the Screen.Next action when the end of a screen list has been reached. |
You can use Application.GetLastError to determine whether this action failed, and why.
When adding an action with the action editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions