exit to top

Typecontrol structure
DictionaryLCS
LibraryLiveCode Script
Syntax
exit to top
Synonymsexit to metacard,exit to supercard,exit to hypercard
Summary

Halts the current handler and all pending handlers.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Example
if the result is not empty then exit to top -- stop everything
RelatedKeyword: card, top
Message: closeCard, openCard
Command: call
Glossary: function handler, message handler, pass, setProp handler, execute, function call, control structure, getProp handler, trigger, getProp call, message path, message, statement, handler, object
Control Structure: pass, exit, if
Description

Use the exit to top control structure to stop executing the current handler and suppress pending messages.

Form: The exit to top statement appears on a line by itself, anywhere inside a handler.

Usually, exit to top is used within an if control structure, so that execution stops if a condition is true and continues if the condition is false.

You can use an exit to top statement in a message handler, function handler, getProp handler, or setProp handler.

If the current handler was called from another handler, the calling handler is also halted. Other messages that depend on the same action are also suppressed: for example, if an exit to top controlstructure is executed in a closeCard handler, the corresponding openCard message is not sent to the destination card.

Important: When a handler executes an exit to top statement, the message, setProp trigger, function call, or getProp call is not passed to the next object in the message path. To halt the current handler and pass the message, trigger, or call to the next object in the message path, use the pass control structure instead of exit or exit to top.