Halt Script script step

Contents > Script steps reference (alphabetical list) > Control script steps > Halt Script script step

Halt Script script step

Format


Halt Script

Options

None.

Web compatibility

This script step is web-compatible.

Description

Forces all scripts (including any sub-scripts or external scripts) to stop immediately. While pressing Esc will also halt a script, Halt Script is useful if you are also using the Allow User Abort script step to disable the Esc key. Halt Script stops the script when Allow User Abort is set to Off.

Example

You can use the Halt Script script step with the Show Custom Dialog script step to present a user with options. If the user clicks Cancel, the script stops; otherwise, the script continues.


Show Custom Dialog ["Delete all records?"]
If [Get (LastMessageChoice) = 2]
   Halt Script
End If
Delete All Records [No Dialog]

Script step categories

Contents > Script steps reference (alphabetical list) > Control script steps > Halt Script script step