Disables or enables all or selected hotkeys.
| Suspend [, Mode] |
Parameters
| Mode | On: Suspends all hotkeys except those explained the Remarks section. Off: Re-enables all hotkeys. Toggle (default): Changes to the opposite of its previous state (On or Off). Permit: Does nothing except mark the current subroutine as being exempt from suspension. |
Remarks
Any hotkey subroutine whose first line is Suspend (except "Suspend On") will be exempt from suspension. In other words, the hotkey will remain enabled even while suspension is ON. This allows suspension to be turned off via such a hotkey.
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 by specifying 1 for the last parameter of the Menu command. For example:
Menu, Tray, Icon, C:\My Icon.ico, , 1
In v1.0.27+, the built-in variable A_IsSuspended contains 1 if the script is suspended and 0 otherwise.
Related
Example
^!s::Suspend ; Assign the toggle-suspend function to a hotkey.