Suspend

Suspend

Disables or enables all or selected hotkeys and hotstrings.

Suspend Mode

Parameters

Mode

On or 1 (true): Suspends all hotkeys and hotstrings except those explained the Remarks section.

Off or 0 (false): Re-enables the hotkeys and hotstrings that were disable above.

Toggle or -1 (default): Changes to the opposite of its previous state (On or Off).

Remarks

By default, the script can also be suspended via its tray icon or main window.

A hotkey/hotstring can be made exempt from suspension by preceding it with the #SuspendExempt directive. An exempt hotkey/hotstring will remain enabled even while suspension is ON. This allows suspension to be turned off via a hotkey, which would otherwise be impossible since the hotkey would be suspended.

The keyboard and/or mouse hooks will be installed or removed if justified by the changes made by this function.

To disable selected hotkeys or hotstrings automatically based on any condition, such as the type of window that is active, use #If.

Suspending a script's hotkeys does not stop the script's already-running threads (if any); use Pause to do that.

When a script's hotkeys are suspended, its tray icon changes to the letter S. This can be avoided by freezing the icon, which is done by specifying 1 for the last parameter of the TraySetIcon function. For example:

TraySetIcon "C:\My Icon.ico", , 1

The built-in variable A_IsSuspended contains 1 if the script is suspended and 0 otherwise.

Related

#SuspendExempt, Hotkeys, Hotstrings, #If, Pause, ExitApp

Example

^!s::Suspend  ; Assign the toggle-suspend function to a hotkey.

; Send a Suspend function to another script.
DetectHiddenWindows True
WM_COMMAND := 0x111
ID_FILE_SUSPEND := 65404
PostMessage WM_COMMAND, ID_FILE_SUSPEND,,, "C:\YourScript.ahk ahk_class AutoHotkey"