StringGetPos()
OutputVar := Mfunc.StringGetPos(Input, SearchText [, L#|R#, Offset])
Retrieves the position of the specified substring within a string.
Input
The name of the input variable, whose contents will be searched.
Can be MfString instance or var containing string.
SearchText
The string to search for. Matching is not case sensitive unless StringCaseSense has been turned on.
Can be MfString instance or var containing string.
L#|R#
This affects which occurrence will be found if SearchText occurs more than once within Input. If this parameter is omitted, Input will be searched starting from the left for the first match. If this parameter is 1 or the letter R, the search will start looking at the right side of Input and will continue leftward until the first match is found.
To find a match other than the first, specify the letter L or R followed by the number of the occurrence. For example, to find the fourth occurrence from the right, specify r4. Note: If the number is less than or equal to zero, no match will be found.
Can be MfString instance or var containing string.
Offset
The number of characters on the leftmost or rightmost side (depending on the parameter above) to skip over. If omitted, the default is 0. For example, the following would start searching at the tenth character from the left: OutputVar := Mfunc.StringGetPos(Input, "abc", , 9). This parameter can be an expression.
Can be MfInteger instance or var containing integer.
Returns the retrieved position relative to the first character of Input. Position 0 is the first character for StringGetPos and position 1 is the first character for InStr().
Wrapper for AutoHotkey Docs - StringGetPos.
Static method.
Unlike StringMid and InStr(), 0 is defined as the position of the first character for StringGetPos.
The retrieved position is always relative to the first character of Input, regardless of whether L#|R# and/or Offset are specified. For example, if the string "abc" is found in 123abc789, its reported position will always be 3 regardless of the method by which it was found.
Use Mfunc.SplitPath to more easily parse a file path into its directory, filename, and extension.
The built-in variables %A_Space% and %A_Tab% contain a single space and a single tab character, respectively. They are useful when searching for spaces and tabs alone or at the beginning or end of SearchText.
See Also:AutoHotkey Docs - StringGetPos.
ErrorLevel is set to 1 if the specified occurrence of SearchText could not be found within Input, or 0 otherwise.
Haystack = abcdefghijklmnopqrs Needle = def
pos := Mfunc.StringGetPos("Haystack", Needle)
if pos >= 0
MsgBox, The string was found at position %pos%.
MfString, MfString.Substring(), MfString.StartsWith(), MfString.EndsWith(), MfString.IndexOf(), MfString.LastIndexOf(), Mfunc.StringMid()