Persistent

Prevents the script from exiting automatically when its last thread completes, allowing it to stay running in an idle state.

Persistent Persist

Parameters

Persist

Type: Boolean

If omitted, it defaults to true.

If true, the script will be kept running after all threads have exited, even if none of the other conditions for keeping the script running are met.

If false, the default behaviour is restored.

Return Value

Type: Integer (boolean)

This function returns the previous setting; either 0 (false) or 1 (true).

Remarks

If Persistent is not used, the default setting is 0 (false).

If the script is persistent, it will stay running after startup completes and all other threads have exited. It is usually unnecessary to call this function because the script is automatically persistent in most of the common cases where the user would want it to keep running, such as to respond to hotkeys, execute timers or display a GUI.

Some cases where this function might be needed (if it is intended to stay running when there are no running threads or hotkeys, timers, etc.) include:

• Scripts which use OnMessage or CallbackCreate and DllCall to respond to events, since those functions don't make the script persistent.
• Scripts that are executed by selecting a custom tray menu item.
• Scripts which create or retrieve COM objects and use ComObjConnect to respond to the object's events.

If this function is added to an existing script, some or all occurrences of Exit might need to be changed to ExitApp. This is because Exit will not terminate a persistent script; it terminates only the current thread.

Related

Exit, ExitApp

Examples

; This script will not exit automatically, even though it has nothing to do.
; However, you can use its tray icon to open the script in an editor, or to
; launch Window Spy or the Help file.
Persistent