StringReplace()
OutputVar := Mfunc.StringReplace(Input, SearchText [, ReplaceText, ReplaceAll?])
Replaces the specified substring with a new string.
Input
The name of the variable whose contents will be read from.
Can be MfString or var containing string.
SearchText
The string to search for. Matching is not case sensitive unless StringCaseSense has been turned on.
Can be MfString or var containing string.
ReplaceText
SearchText will be replaced with this text. If omitted or null, SearchText will be replaced with null (empty). In other words, it will be omitted from return value.
Can be MfString or var containing string.
ReplaceAll?
If omitted, only the first occurrence of SearchText will be replaced. But if this parameter is 1, A, or All, all occurrences will be replaced.
Can be MfString or var containing string.
Specify the word UseErrorLevel to store in ErrorLevel the number of occurrences replaced (0 if none). UseErrorLevel implies "All".
Returns the result of the replacement process.
Wrapper for AutoHotkey Docs - StringReplace.
Static method.
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.
In AutoHotkey [v1.0.45], the AllSlow option became obsolete due to improvements to performance and memory utilization. Although it may still be specified, it has no effect.
Any and/or all parameter for this function can be instance of MfString or var containing string.
See Also:AutoHotkey Docs - StringReplace.
; Remove all CR+LF's from the clipboard contents:
clipboard := Mfunc.StringReplace(clipboard, "`r`n", , "All")
; Replace all spaces with pluses:
mfsOldString := new MfString("My String With Something to Say!")
NewStr := Mfunc.StringReplace(mfsOldString, A_SPACE, "+", "All")
MsgBox %NewStr% ; Displays: My+String+With+Something+to+Say!
; Remove all blank lines from the text in a variable:
Loop
{
MyString := Mfunc.StringReplace(MyString, "`r`n`r`n", "`r`n", "UseErrorLevel")
if ErrorLevel = 0 ; No more replacements needed.
break
}