List of commands that affect ErrorLevel

iPhilip · 02 Apr 2018, 16:59

Has anyone catalogued the built-in commands that affect ErrorLevel? I would find it useful.

TheDewd · 09 Apr 2018, 12:18

iPhilip · 09 Apr 2018, 14:07

Thank you! I went through the same steps but couldn't figure out how to save the results. I appreciate you doing that and, for my own education, am curious if there is a simple way to get the list you posted.

TheDewd · 09 Apr 2018, 14:28

iPhilip wrote:Thank you! I went through the same steps but couldn't figure out how to save the results. I appreciate you doing that and, for my own education, am curious if there is a simple way to get the list you posted.

I'm happy to share the methods I used! You can probably adapt this for use in your web browser of choice.

1) Open Mozilla Firefox
2) Navigate to https://autohotkey.com/docs/commands/index.htm
3) Click the 'Search' tab in upper-left corner
4) Enter "ErrorLevel" in the search field
5) Press F12 key to open 'Developer Tools'
6) Click the 'Inspector' tab from the Developer Tools panel/window.
7) Expand the Source HTML until you find div.list

Code: Select all

html
	body
		div#body
			div#main
				div#left
					div.search
						div.list

8) When you find <div class="list">, right-click it and choose "Copy" > "Inner HTML"
9) Paste clipboard contents into Notepad++
10) Use Find/Replace (and more) until the list is formatted to your liking.

jeeswg · 09 Apr 2018, 14:30

Decompile the chm using 7-Zip to give multiple files, and try NirSoft SearchMyFiles, searching for ErrorLevel, and get a list of htm files.

jeeswg · 09 Apr 2018, 15:13

Here's a script, to get the name/title/relevant lines of text, for htm files that contain a string.

Code: Select all

q:: ;get htm files that contain needle
vNeedle := "ErrorLevel"
vDir1 := A_Desktop "\AutoHotkey_1.1.28.02\AutoHotkey\docs\commands"
VarSetCapacity(vOutput, 1000000*2)
Loop, Files, % vDir1 "\*.htm", F
{
	vPath := A_LoopFileFullPath
	SplitPath, vPath, vName, vDir, vExt, vNameNoExt, vDrive
	FileRead, vHtml, % vPath
	if !InStr(vHtml, vNeedle)
		continue
	vOutput .= "[TITLE] " JEE_HtmlGetTitle(vHtml) "`r`n"
	vHtml := RegExReplace(vHtml, "<.*?>")
	vOutput .= "[NAME] " vName "`r`n"
	Loop, Parse, vHtml, `n, `r
		if InStr(A_LoopField, vNeedle)
			vOutput .= A_LoopField "`r`n"
}
Clipboard := vOutput
MsgBox, % "done"
return

;==================================================

JEE_HtmlGetTitle(ByRef vHtml)
{
	if (vHtml = "")
		return
	vPos1 := InStr(vHtml, "<title>")
	if !vPos1
		vPos1 := InStr(vHtml, "<title")
	vPos2 := InStr(vHtml, "</title>", 0, vPos1) + 7
	if vPos1 && !(vPos2 = 7)
		vHtml2 := SubStr(vHtml, vPos1, vPos2-vPos1+1)
	else
		return

	oHTML := ComObjCreate("HTMLFile")
	oHTML.Write(vHtml2)
	try vText := oHTML.getElementsByTagName("title")[0].innerText
	oHTML := ""

	vText := StrReplace(vText, "`r", " ")
	vText := StrReplace(vText, "`n", " ")
	vText := StrReplace(vText, "`t", " ")
	vText := Trim(vText, " ")
	vText := RegExReplace(vText, " {2,}", " ")
	return vText
}

iPhilip · 17 Apr 2018, 20:26

TheDewd wrote:I'm happy to share the methods I used! You can probably adapt this for use in your web browser of choice.

1) Open Mozilla Firefox
2) Navigate to https://autohotkey.com/docs/commands/index.htm
3) Click the 'Search' tab in upper-left corner
4) Enter "ErrorLevel" in the search field
5) Press F12 key to open 'Developer Tools'
6) Click the 'Inspector' tab from the Developer Tools panel/window.
7) Expand the Source HTML until you find div.list
Code: Select all
html
	body
		div#body
			div#main
				div#left
					div.search
						div.list
8) When you find <div class="list">, right-click it and choose "Copy" > "Inner HTML"
9) Paste clipboard contents into Notepad++
10) Use Find/Replace (and more) until the list is formatted to your liking.

Hi TheDewd,

Thank you! That was very helpful. I used the results of that approach to post a suggestion for documentation improvements here.

jeeswg wrote:Here's a script, to get the name/title/relevant lines of text, for htm files that contain a string.

Code: Select all

q:: ;get htm files that contain needle
vNeedle := "ErrorLevel"
vDir1 := A_Desktop "\AutoHotkey_1.1.28.02\AutoHotkey\docs\commands"
VarSetCapacity(vOutput, 1000000*2)
Loop, Files, % vDir1 "\*.htm", F
{
	vPath := A_LoopFileFullPath
	SplitPath, vPath, vName, vDir, vExt, vNameNoExt, vDrive
	FileRead, vHtml, % vPath
	if !InStr(vHtml, vNeedle)
		continue
	vOutput .= "[TITLE] " JEE_HtmlGetTitle(vHtml) "`r`n"
	vHtml := RegExReplace(vHtml, "<.*?>")
	vOutput .= "[NAME] " vName "`r`n"
	Loop, Parse, vHtml, `n, `r
		if InStr(A_LoopField, vNeedle)
			vOutput .= A_LoopField "`r`n"
}
Clipboard := vOutput
MsgBox, % "done"
return

;==================================================

JEE_HtmlGetTitle(ByRef vHtml)
{
	if (vHtml = "")
		return
	vPos1 := InStr(vHtml, "<title>")
	if !vPos1
		vPos1 := InStr(vHtml, "<title")
	vPos2 := InStr(vHtml, "</title>", 0, vPos1) + 7
	if vPos1 && !(vPos2 = 7)
		vHtml2 := SubStr(vHtml, vPos1, vPos2-vPos1+1)
	else
		return

	oHTML := ComObjCreate("HTMLFile")
	oHTML.Write(vHtml2)
	try vText := oHTML.getElementsByTagName("title")[0].innerText
	oHTML := ""

	vText := StrReplace(vText, "`r", " ")
	vText := StrReplace(vText, "`n", " ")
	vText := StrReplace(vText, "`t", " ")
	vText := Trim(vText, " ")
	vText := RegExReplace(vText, " {2,}", " ")
	return vText
}

Hi jeeswg,

Thank you, too. That's a very powerful script. There was a lot of material to sort through in the results (519 lines!). I appreciate you sharing the script, especially your function.

Cheers!

jeeswg · 18 Apr 2018, 17:49

- I used my script above to produce a list. I retrieved the text, replaced ErrorLevel with ERRORLEVEL to make occurrences more obvious, and read through the whole thing manually. Hopefully the list is correct, but it's so hard to get these things perfect.
- AFAICT all of the items in both TheDewd's and iPhilip's lists are correct, however, there may be around 30 items missing. Btw this list includes commands *and* functions. I see no reason to exclude functions.
- The two lists:
List of commands that affect ErrorLevel - AutoHotkey Community
https://autohotkey.com/boards/viewtopic ... 00#p211500
Suggestions on documentation improvements - Page 20 - AutoHotkey Community
https://autohotkey.com/boards/viewtopic ... 25#p213325
- To assume that if a command's page contains 'ErrorLevel' means that the command uses it, would give you false positives. However, if the page contains 'ErrorLevel is set to' this is usually a good indicator.
- Some command/function pages mention ErrorLevel explicitly to say that it is *not* set by the command/function: Hotstring, IniRead, RunAs, WinClose, WinKill.
- It might be worth adding additional info to the list below, e.g. commands that only set ErrorLevel if UseErrorLevel is used etc.
- I've added a link to this page to my list of commands/functions etc.
list of every command/function/variable from across all versions - AutoHotkey Community
https://autohotkey.com/boards/viewtopic ... 42#p131642
- My list. Note: the text comes directly from the webpage titles.

Code: Select all

;AHK v1 commands/functions that set ErrorLevel
ClipWait
Control
ControlClick
ControlFocus
ControlGet
ControlGetFocus
ControlGetText
ControlMove
ControlSend[Raw]
ControlSetText
DllCall
Drive
DriveGet
EnvSet
EnvUpdate
FileAppend
FileCopy
FileCopyDir
FileCreateDir
FileCreateShortcut
FileDelete
FileGetAttrib
FileGetShortcut
FileGetSize
FileGetTime
FileGetVersion
FileInstall
FileMove
FileMoveDir
FileRead
FileReadLine
FileRecycle
FileRecycleEmpty
FileRemoveDir
FileSelectFile
FileSelectFolder
FileSetAttrib
FileSetTime
GroupActivate
GUI
GuiControl
GuiControlGet
Hotkey
ImageSearch
IniDelete
IniWrite
Input
InputBox
KeyWait
Menu
PixelGetColor
PixelSearch
PostMessage / SendMessage
Process
RegDelete
RegExMatch
RegExReplace
RegRead
RegWrite
Run[Wait]
SetWorkingDir
Sort
SoundGet
SoundGetWaveVolume
SoundPlay
SoundSet
SoundSetWaveVolume
StatusbarGetText
StatusBarWait
StringGetPos
StringReplace / StrReplace() [note: StringReplace can affect ErrorLevel, but not StrReplace]
UrlDownloadToFile
WinGetText
WinMenuSelectItem
WinSet
WinWait
WinWait[Not]Active
WinWaitClose

Taken out: Loop (registry). [RegRead/RegWrite can affect ErrorLevel, but not Loop]

[EDIT:] A full list has been added here:
ErrorLevel
https://autohotkey.com/docs/misc/ErrorLevel.htm

List of commands that affect ErrorLevel Topic is solved

List of commands that affect ErrorLevel

Re: List of commands that affect ErrorLevel

Re: List of commands that affect ErrorLevel

Re: List of commands that affect ErrorLevel

Re: List of commands that affect ErrorLevel

Re: List of commands that affect ErrorLevel

Re: List of commands that affect ErrorLevel

Re: List of commands that affect ErrorLevel Topic is solved

Who is online