Skip to content
Thoroughbred Software InternationalThoroughbred Software InternationalThoroughbred DocumentationDocs

ESCAPE-KEY

FUNCTION

This command specifies custom escape processing to be used when the Escape key is pressed as a script executes.

SYNTAX

ESCAPE-KEY PROCESS IS procedure | OFF | ON

procedure the name of a procedure to perform.

NOTES

  • The ESCAPE-KEY command can specify a procedure which overrides the setting of the ESCAPE variable and the default processing for the Escape key.
  • ESCAPE-KEY OFF turns custom processing off and sets escape processing back to the standard processing.
  • ESCAPE-KEY ON reactivates the custom escape processing and sets it to the last active or specified procedure. If no previous processing was defined in the script, the command ESCAPE-KEY ON is ignored.
  • In primary and continuation scripts, multiple ESCAPE-KEY processes can be logically used. The escape processing set with the ESCAPE-KEY command overrides any previously defined custom processing.
  • In public and overlay scripts, only one escape procedure should be specified. If multiple ESCAPE-KEY commands are used, the last one encountered by the compiler is the only one performed.

EXAMPLES

ESCAPE-KEY PROCESS IS END-SCRIPT


ESCAPE-KEY OFF

SEE ALSO

ESCAPE, and the section on Escape Processing in the Script-IV Developer Guide.

From the Script-IV Language Reference, version 8.9.1. Open this page in the PDF