/AutoHotkey.docset/Contents/Resources/Documents/commands/Suspend.htm

https://gitlab.com/ahkscript/Autohotkey.docset · HTML · 48 lines · 40 code · 8 blank · 0 comment · 0 complexity · 1b4d97d68ca55dcc37ebe9f473cc703f MD5 · raw file 

    

  1. <!DOCTYPE HTML>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Suspend</title>
    5. 

  5. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    6. 

  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
    7. 

  7. <link href="../static/theme.css" rel="stylesheet" type="text/css" />
    8. 

  8. <script src="../static/content.js" type="text/javascript"></script>
    9. 

  9. </head>
    10. 

  10. <body>
    11. 

  11. 

  12. <h1>Suspend</h1>
    13. 

  13. 

  14. <p>Disables or enables all or selected <a href="../Hotkeys.htm">hotkeys</a> and <a href="../Hotstrings.htm">hotstrings</a>.</p>
    15. 

  15. 

  16. <pre class="Syntax">Suspend [, Mode]</pre>
    17. 

  17. <h3>Parameters</h3>
    18. 

  18. <dl>
    19. 

  19. 

  20.   <dt>Mode</dt>
    21. 

  21.   <dd><p><strong>On</strong>: Suspends all <a href="../Hotkeys.htm">hotkeys</a> and <a href="../Hotstrings.htm">hotstrings</a> except those explained the Remarks section.</p>
    22. 

  22.       <p><strong>Off</strong>: Re-enables the hotkeys and hotstrings that were disable above.</p>
    23. 

  23.       <p><strong>Toggle</strong> (default): Changes to the opposite of its previous state (On or Off).</p>
    24. 

  24.     <p><strong>Permit</strong>: Does nothing except mark the current subroutine as being exempt from suspension.</p></dd>
    25. 

  25. 

  26. </dl>
    27. 

  27. 

  28. <h3>Remarks</h3>
    29. 

  29. <p>Any hotkey/hotstring subroutine whose very first line is Suspend (except <code>Suspend On</code>) 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.</p>
    30. 

  30. <p>The <a href="_InstallKeybdHook.htm">keyboard</a> and/or <a href="_InstallMouseHook.htm">mouse</a> hooks will be installed or removed if justified by the changes made by this command.</p>
    31. 

  31. <p>To disable selected hotkeys or hotstrings automatically based on the type of window that is present, use <a href="_IfWinActive.htm">#IfWinActive/Exist</a>.</p>
    32. 

  32. <p>Suspending a script's hotkeys does not stop the script's already-running <a href="../misc/Threads.htm">threads</a> (if any); use <a href="Pause.htm">Pause</a> to do that.</p>
    33. 

  33. <p>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 Menu command. For example:</p>
    34. 

  34. <pre><a href="Menu.htm">Menu</a>, Tray, Icon, C:\My Icon.ico, , 1</pre>
    35. 

  35. <p>The built-in variable A_IsSuspended contains 1 if the script is suspended and 0 otherwise.</p>
    36. 

  36. <h3>Related</h3>
    37. 

  37. <p><a href="_IfWinActive.htm">#IfWinActive/Exist</a>, <a href="Pause.htm">Pause</a>, <a href="Menu.htm">Menu</a>, <a href="ExitApp.htm">ExitApp</a></p>
    38. 

  38. <h3>Example</h3>
    39. 

  39. <pre class="NoIndent">^!s::Suspend  <em>; Assign the toggle-suspend function to a hotkey.</em></pre>
    40. 

  40. 

  41. <pre id="PostMessage" class="NoIndent"><em>; Send a Suspend command to another script.</em>
    42. 

  42. <a href="DetectHiddenWindows.htm">DetectHiddenWindows</a>, On
    43. 

  43. WM_COMMAND := 0x111
    44. 

  44. ID_FILE_SUSPEND := 65404
    45. 

  45. <a href="PostMessage.htm">PostMessage</a>, WM_COMMAND, ID_FILE_SUSPEND,,, C:\YourScript.ahk ahk_class AutoHotkey</pre>
    46. 

  46. 

  47. </body>
    48. 

  48. </html>
    49.