Exit

Exits the current thread.

Exit ExitCode

Parameters

ExitCode

Type: Integer

An integer between -2147483648 and 2147483647 that is returned to its caller when the script exits. This code is accessible to any program that spawned the script, such as another script (via RunWait) or a batch (.bat) file. If omitted, ExitCode defaults to zero. Zero is traditionally used to indicate success.

Remarks

The Exit function terminates only the current thread. In other words, the stack of functions called directly or indirectly by a menu, timer, or hotkey function will all be returned from as though a Return were immediately encountered in each. If used directly inside such a function -- or in global code -- Exit is equivalent to Return.

If the script is not persistent and this is the last thread, the script will terminate after the thread exits.

Use ExitApp to completely terminate a script that is persistent.

ExitApp, OnExit, Functions, Return, Threads, Persistent

Examples

In this example, the Exit function terminates the call_exit function as well as the calling function.

#z::
{
    call_exit
    MsgBox "This MsgBox will never happen because of the Exit."
    call_exit() 
    {
        Exit ; Terminate this function as well as the calling function.
    }
}