PageRenderTime 37ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/misc/ErrorLevel.htm

http://github.com/Lexikos/AutoHotkey_L-Docs
HTML | 116 lines | 114 code | 2 blank | 0 comment | 0 complexity | 115790558665f66150e87153290ae461 MD5 | raw file
    

  1. <!DOCTYPE HTML>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. <title>ErrorLevel - Definition &amp; Usage | AutoHotkey</title>
    5. 

  5. <meta name="description" content="ErrorLevel is a built-in variable that is set to indicate the success or failure of some of the commands, functions and GUI/Control events." />
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    7. 

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

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

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

  10. </head>
    11. 

  11. 

  12. <body>
    13. 

  13. <h1>ErrorLevel</h1>
    14. 

  14. 

  15. <p>This is a built-in variable that is set to indicate the success or failure of some of the commands (not all commands change the value of ErrorLevel). A value of 0 usually indicates success, and any other value usually indicates failure. You can also set the value of ErrorLevel yourself.</p>
    16. 

  16. <p>Of special interest is that <a href="../commands/Run.htm">RunWait</a> sets ErrorLevel to be the exit code of the program it ran. Most programs yield an exit code of zero if they completed successfully.</p>
    17. 

  17. <p>Each <a href="Threads.htm">thread</a> retains its own value of ErrorLevel, meaning that if the <a href="Threads.htm">current thread</a> is interrupted by another, when the original thread is resumed it will still have its original value of ErrorLevel, not the ErrorLevel that may have been set by the interrupting thread.</p>
    18. 

  18. <p class="note"><strong>Note</strong>: Since some commands set ErrorLevel to values higher than 1, it is best not check whether ErrorLevel is 1, but instead whether ErrorLevel is not zero.</p>
    19. 

  19. <p>The following list contains all commands, functions and GUI/Control events which set ErrorLevel, including the possible ErrorLevel values:</p>
    20. 

  20. <table class="info">
    21. 

  21.     <tr><td><a href="../commands/ClipWait.htm">ClipWait</a></td><td>0, 1</td></tr>
    22. 

  22.     <tr><td><a href="../commands/Control.htm">Control</a></td><td>0, 1</td></tr>
    23. 

  23.     <tr><td><a href="../commands/ControlClick.htm">ControlClick</a></td><td>0, 1</td></tr>
    24. 

  24.     <tr><td><a href="../commands/ControlFocus.htm">ControlFocus</a></td><td>0, 1</td></tr>
    25. 

  25.     <tr><td><a href="../commands/ControlGet.htm">ControlGet</a></td><td>0, 1</td></tr>
    26. 

  26.     <tr><td><a href="../commands/ControlGetFocus.htm">ControlGetFocus</a></td><td>0, 1</td></tr>
    27. 

  27.     <tr><td><a href="../commands/ControlGetText.htm">ControlGetText</a></td><td>0, 1</td></tr>
    28. 

  28.     <tr><td><a href="../commands/ControlMove.htm">ControlMove</a></td><td>0, 1</td></tr>
    29. 

  29.     <tr><td><a href="../commands/ControlSend.htm">ControlSend / ControlSendRaw</a></td><td>0, 1</td></tr>
    30. 

  30.     <tr><td><a href="../commands/ControlSetText.htm">ControlSetText</a></td><td>0, 1</td></tr>
    31. 

  31.     <tr><td><a href="../commands/DllCall.htm">DllCall()</a></td><td>0, -1, -2, -3, -4, <em>n</em>, A<em>n</em></td></tr>
    32. 

  32.     <tr><td><a href="../commands/Drive.htm">Drive</a></td><td>0, 1</td></tr>
    33. 

  33.     <tr><td><a href="../commands/DriveGet.htm">DriveGet</a></td><td>0, 1</td></tr>
    34. 

  34.     <tr><td><a href="../commands/EnvSet.htm">EnvSet</a></td><td>0, 1</td></tr>
    35. 

  35.     <tr><td><a href="../commands/EnvUpdate.htm">EnvUpdate</a></td><td>0, 1</td></tr>
    36. 

  36.     <tr><td><a href="../commands/FileAppend.htm">FileAppend</a></td><td>0, 1</td></tr>
    37. 

  37.     <tr><td><a href="../commands/FileCopy.htm">FileCopy</a></td><td>0, <em>n</em></td></tr>
    38. 

  38.     <tr><td><a href="../commands/FileCopyDir.htm">FileCopyDir</a></td><td>0, 1</td></tr>
    39. 

  39.     <tr><td><a href="../commands/FileCreateDir.htm">FileCreateDir</a></td><td>0, 1</td></tr>
    40. 

  40.     <tr><td><a href="../commands/FileCreateShortcut.htm">FileCreateShortcut</a></td><td>0, 1</td></tr>
    41. 

  41.     <tr><td><a href="../commands/FileDelete.htm">FileDelete</a></td><td>0, <em>n</em></td></tr>
    42. 

  42.     <tr><td><a href="../commands/FileGetAttrib.htm">FileGetAttrib</a></td><td>0, 1</td></tr>
    43. 

  43.     <tr><td><a href="../commands/FileGetShortcut.htm">FileGetShortcut</a></td><td>0, 1</td></tr>
    44. 

  44.     <tr><td><a href="../commands/FileGetSize.htm">FileGetSize</a></td><td>0, 1</td></tr>
    45. 

  45.     <tr><td><a href="../commands/FileGetTime.htm">FileGetTime</a></td><td>0, 1</td></tr>
    46. 

  46.     <tr><td><a href="../commands/FileGetVersion.htm">FileGetVersion</a></td><td>0, 1</td></tr>
    47. 

  47.     <tr><td><a href="../commands/FileInstall.htm">FileInstall</a></td><td>0, 1</td></tr>
    48. 

  48.     <tr><td><a href="../commands/FileMove.htm">FileMove</a></td><td>0, <em>n</em></td></tr>
    49. 

  49.     <tr><td><a href="../commands/FileMoveDir.htm">FileMoveDir</a></td><td>0, 1</td></tr>
    50. 

  50.     <tr><td><a href="../commands/FileRead.htm">FileRead</a></td><td>0, 1</td></tr>
    51. 

  51.     <tr><td><a href="../commands/FileReadLine.htm">FileReadLine</a></td><td>0, 1</td></tr>
    52. 

  52.     <tr><td><a href="../commands/FileRecycle.htm">FileRecycle</a></td><td>0, 1</td></tr>
    53. 

  53.     <tr><td><a href="../commands/FileRecycleEmpty.htm">FileRecycleEmpty</a></td><td>0, 1</td></tr>
    54. 

  54.     <tr><td><a href="../commands/FileRemoveDir.htm">FileRemoveDir</a></td><td>0, 1</td></tr>
    55. 

  55.     <tr><td><a href="../commands/FileSelectFile.htm">FileSelectFile</a></td><td>0, 1</td></tr>
    56. 

  56.     <tr><td><a href="../commands/FileSelectFolder.htm">FileSelectFolder</a></td><td>0, 1</td></tr>
    57. 

  57.     <tr><td><a href="../commands/FileSetAttrib.htm">FileSetAttrib</a></td><td>0, <em>n</em></td></tr>
    58. 

  58.     <tr><td><a href="../commands/FileSetTime.htm">FileSetTime</a></td><td>0, 1</td></tr>
    59. 

  59.     <tr><td><a href="../commands/GroupActivate.htm">GroupActivate</a></td><td>0, 1</td></tr>
    60. 

  60.     <tr><td><a href="../commands/Gui.htm#GuiSize">Gui: GuiSize event</a></td><td>0, 1, 2</td></tr>
    61. 

  61.     <tr><td><a href="../commands/Gui.htm#GuiDropFiles">Gui: GuiDropFiles event</a></td><td>0, <em>n</em></td></tr>
    62. 

  62.     <tr><td><a href="../commands/GuiControl.htm">GuiControl</a></td><td>0, 1</td></tr>
    63. 

  63.     <tr><td><a href="../commands/GuiControlGet.htm">GuiControlGet</a></td><td>0, 1</td></tr>
    64. 

  64.     <tr><td><a href="../commands/GuiControls.htm#Link">Gui control: Link click event</a></td><td><em>string</em></td></tr>
    65. 

  65.     <tr><td><a href="../commands/GuiControls.htm#Custom">Gui control: Custom event</a></td><td>0, <em>n</em></td></tr>
    66. 

  66.     <tr><td><a href="../commands/ListView.htm#ItemChanged">Gui control: ListView item change event</a></td><td>subset of "SsFfCc"</td></tr>
    67. 

  67.     <tr><td><a href="../commands/Hotkey.htm">Hotkey</a></td><td>0, 1, 2, 3, 4, 5, 6, 98, 99</td></tr>
    68. 

  68.     <tr><td><a href="../commands/ImageSearch.htm">ImageSearch</a></td><td>0, 1, 2</td></tr>
    69. 

  69.     <tr><td><a href="../commands/IniDelete.htm">IniDelete</a></td><td>0, 1</td></tr>
    70. 

  70.     <tr><td><a href="../commands/IniWrite.htm">IniWrite</a></td><td>0, 1</td></tr>
    71. 

  71.     <tr><td><a href="../commands/Input.htm">Input</a></td><td>0, 1, NewInput, Max, Timeout, Match, EndKey:Name</td></tr>
    72. 

  72.     <tr><td><a href="../commands/InputBox.htm">InputBox</a></td><td>0, 1, 2</td></tr>
    73. 

  73.     <tr><td><a href="../commands/KeyWait.htm">KeyWait</a></td><td>0, 1</td></tr>
    74. 

  74.     <tr><td><a href="../commands/Menu.htm">Menu</a></td><td>0, 1</td></tr>
    75. 

  75.     <tr><td><a href="../commands/PixelGetColor.htm">PixelGetColor</a></td><td>0, 1</td></tr>
    76. 

  76.     <tr><td><a href="../commands/PixelSearch.htm">PixelSearch</a></td><td>0, 1, 2</td></tr>
    77. 

  77.     <tr><td><a href="../commands/PostMessage.htm">PostMessage</a></td><td>0, 1</td></tr>
    78. 

  78.     <tr><td><a href="../commands/Process.htm">Process</a></td><td>0, <em>PID</em></td></tr>
    79. 

  79.     <tr><td><a href="../commands/RegDelete.htm">RegDelete</a></td><td>0, 1</td></tr>
    80. 

  80.     <tr><td><a href="../commands/RegExMatch.htm">RegExMatch()</a></td><td>0, <em>string</em>, -<em>n</em></td></tr>
    81. 

  81.     <tr><td><a href="../commands/RegExReplace.htm">RegExReplace()</a></td><td>0, <em>string</em>, -<em>n</em></td></tr>
    82. 

  82.     <tr><td><a href="../commands/RegRead.htm">RegRead</a></td><td>0, 1</td></tr>
    83. 

  83.     <tr><td><a href="../commands/RegWrite.htm">RegWrite</a></td><td>0, 1</td></tr>
    84. 

  84.     <tr><td><a href="../commands/Run.htm">Run</a></td><td>0, ERROR</td></tr>
    85. 

  85.     <tr><td><a href="../commands/Run.htm">RunWait</a></td><td><em>n</em>, ERROR</td></tr>
    86. 

  86.     <tr><td><a href="../commands/PostMessage.htm">SendMessage</a></td><td>FAIL, <em>n</em></td></tr>
    87. 

  87.     <tr><td><a href="../commands/SetWorkingDir.htm">SetWorkingDir</a></td><td>0, 1</td></tr>
    88. 

  88.     <tr><td><a href="../commands/Sort.htm#unique">Sort: U option</a></td><td>0, <em>n</em></td></tr>
    89. 

  89.     <tr><td><a href="../commands/SoundGet.htm">SoundGet</a></td><td>0, <em>string</em></td></tr>
    90. 

  90.     <tr><td><a href="../commands/SoundGetWaveVolume.htm">SoundGetWaveVolume</a></td><td>0, 1</td></tr>
    91. 

  91.     <tr><td><a href="../commands/SoundPlay.htm">SoundPlay</a></td><td>0, 1</td></tr>
    92. 

  92.     <tr><td><a href="../commands/SoundSet.htm">SoundSet</a></td><td>0, <em>string</em></td></tr>
    93. 

  93.     <tr><td><a href="../commands/SoundSetWaveVolume.htm">SoundSetWaveVolume</a></td><td>0, 1</td></tr>
    94. 

  94.     <tr><td><a href="../commands/StatusBarGetText.htm">StatusBarGetText</a></td><td>0, 1</td></tr>
    95. 

  95.     <tr><td><a href="../commands/StatusBarWait.htm">StatusBarWait</a></td><td>0, 1, 2</td></tr>
    96. 

  96.     <tr><td><a href="../commands/StringGetPos.htm">StringGetPos</a></td><td>0, 1</td></tr>
    97. 

  97.     <tr><td><a href="../commands/StringReplace.htm">StringReplace</a></td><td>0, 1, <em>n</em></td></tr>
    98. 

  98.     <tr><td><a href="../commands/URLDownloadToFile.htm">UrlDownloadToFile</a></td><td>0, 1</td></tr>
    99. 

  99.     <tr><td><a href="../commands/WinGetText.htm">WinGetText</a></td><td>0, 1</td></tr>
    100. 

  100.     <tr><td><a href="../commands/WinMenuSelectItem.htm">WinMenuSelectItem</a></td><td>0, 1</td></tr>
    101. 

  101.     <tr><td><a href="../commands/WinSet.htm">WinSet Style/ExStyle/Region</a></td><td>0, 1</td></tr>
    102. 

  102.     <tr><td><a href="../commands/WinWait.htm">WinWait</a></td><td>0, 1</td></tr>
    103. 

  103.     <tr><td><a href="../commands/WinWaitActive.htm">WinWaitActive / WinWaitNotActive</a></td><td>0, 1</td></tr>
    104. 

  104.     <tr><td><a href="../commands/WinWaitClose.htm">WinWaitClose</a></td><td>0, 1</td></tr>
    105. 

  105. </table>
    106. 

  106. <h2>Examples</h2>
    107. 

  107. <div class="ex" id="ExBasic">
    108. 

  108. <p><a href="#ExBasic">#1</a></p>
    109. 

  109. <pre>WinWait, MyWindow, , 1
    110. 

  110. if ErrorLevel   <em>; i.e. it's not blank or zero.</em>
    111. 

  111.     MsgBox, The window does not exist.
    112. 

  112. else
    113. 

  113.     MsgBox, The window exists.</pre>
    114. 

  114. </div>
    115. 

  115. </body>
    116. 

  116. </html>
    117. 

  117.