Searches for a given occurrence of a string, from the left or the right.
FoundPos := InStr(Haystack, Needle , CaseSensitive, StartingPos, Occurrence)
The string whose content is searched.
The string to search for.
If blank or omitted, it defaults to 0 (false). Otherwise, specify 1 (true) to make the search case-sensitive, i.e. the case must match exactly. The method of insensitivity depends on StringCaseSense.
If omitted, it defaults to 1 (the beginning of Haystack). Otherwise, specify 2 to start at the second character, 3 to start at the third, and so on.
If StartingPos is beyond the length of Haystack, 0 is returned. [AHK_L 57+]: If StartingPos is blank, 0 or negative, the search is conducted in reverse (right-to-left) beginning at that offset from the end.
Regardless of the value of StartingPos, the return value is always relative to the first character of Haystack. For example, the position of "abc" in "123abc789" is always 4.
If omitted, it defaults to 1 (the first match in Haystack). If blank, it defaults to 0. Otherwise, specify 2 to return the position of the second match, 3 for the third match, etc.
This function returns the position of an occurrence of the string Needle in the string Haystack. Position 1 is the first character; this is because 0 is synonymous with "false", making it an intuitive "not found" indicator.
An occurrence of an empty string (
"") can be found at any position; therefore, if Needle is an empty string, the return value is 1. As a blank Needle would typically only be passed by mistake, it will be treated as an error in AutoHotkey v2.
This function is a combination of IfInString and StringGetPos.
RegExMatch() can be used to search for a pattern (regular expression) within a string, making it much more flexible than InStr(). However, InStr() is generally faster than RegExMatch() when searching for a simple substring.
RegExMatch(), StringGetPos, IfInString, StringCaseSense, If Var [not] in/contains MatchList, If Var [not] between Low and High, If Var is [not] Type
MsgBox % InStr("123abc789", "abc") ; Returns 4
Haystack := "The Quick Brown Fox Jumps Over the Lazy Dog" Needle := "Fox" If InStr(Haystack, Needle) MsgBox, The string was found. Else MsgBox, The string was not found.
Haystack := "The Quick Brown Fox Jumps Over the Lazy Dog" Needle := "the" MsgBox % InStr(Haystack, Needle, false, 1, 2) ; case-insensitive search, return start position of second occurence MsgBox % InStr(Haystack, Needle, true) ; case-sensitive search, return start position of first occurence, same result as above