Contains()
Returns a value indicating whether a specified substring occurs within a string.
OutputVar := instance.Contains(searchChar)
OutputVar := instance.Contains(searchChar, startIndex)
OutputVar := instance.Contains(searchChar, startIndex, count)
OutputVar := instance.Contains(strSearch)
OutputVar := instance.Contains(strSearch, startIndex)
OutputVar := instance.Contains(strSearch, startIndex, count)
OutputVar := MfString.Contains(strMain, searchChar)
OutputVar := MfString.Contains(strMain, searchChar, startIndex)
OutputVar := MfString.Contains(strMain, searchChar, startIndex, count)
OutputVar := MfString.Contains(strMain, strSearch)
OutputVar := MfString.Contains(strMain, strSearch, startIndex)
OutputVar := MfString.Contains(strMain, strSearch, startIndex, count)
Reports if there is an occurrence of a character specified by searchChar within this instance.
searchChar
The Character to seek.
Can be instance of MfChar or string var containing character.
true if the searchChar parameter occurs within this instance,or if searchChar CharCode equals 0; otherwise, false.
See Example
Reports if there is an occurrence of a character specified by searchChar within this instance. The search starts at a character position specified by startIndex.
searchChar
The Character to seek.
Can be instance of MfChar or string var containing character.
startIndex
An integer representing the starting position of the search.
Can be MfInteger instance or var containing integer.
true if the searchChar parameter occurs within this instance,or if searchChar CharCode equals 0; otherwise, false.
See Example
Reports if there is an occurrence of a character specified by searchChar within this instance. The search starts at a character position specified by startIndex and examines a number of character positions specified by count.
searchChar
The Character to seek.
Can be instance of MfChar or string var containing character.
startIndex
An integer representing the starting position of the search.
Can be MfInteger instance or var containing integer.
count
An integer representing the number of character positions to examine.
Can be MfInteger instance or var containing integer.
true if the searchChar parameter occurs within this instance,or if searchChar CharCode equals 0; otherwise, false.
See Example
Reports if there is an occurrence of a string specified by strSearch within this instance.
strSearch
The string to seek.
Can be MfString instance or var containing string.
true if the strSearch parameter occurs within this string, or if strSearch is the empty string (""); otherwise, false.
See Example
Reports if there is an occurrence of a string specified by strSearch within this instance. The search starts at a character specified by startIndex position.
strSearch
The string to seek.
Can be MfString instance or var containing string.
startIndex
An integer representing the starting position of the search.
Can be MfInteger instance or var containing integer.
true if the strSearch parameter occurs within this string, or if strSearch is the empty string (""); otherwise, false.
See Example
Reports if there is an occurrence of a string specified by strSearch within this instance. The search starts at a character specified by startIndex position and examines a number of character positions specified by count.
strSearch
The string to seek.
Can be MfString instance or var containing string.
startIndex
An integer representing the starting position of the search.
Can be MfInteger instance or var containing integer.
count
An integer representing the number of character positions to examine.
Can be MfInteger instance or var containing integer.
true if the strSearch parameter occurs within this string, or if strSearch is the empty string (""); otherwise, false.
See Example
Reports if there is an occurrence of a character specified by searchChar within strMain.
strMain
The main String to search for last index of specified parameters.
Can be MfString instance or var containing string.
searchChar
The Character to seek.
Can be instance of MfChar or string var containing character.
true if the searchChar parameter occurs within strMain, or if searchChar CharCode equals 0; otherwise, false.
Static Method
See Example
Reports if there is an occurrence of a character specified by searchChar within strMain. The search starts at a character specified by startIndex position.
strMain
The main String to search for last index of specified parameters.
Can be MfString instance or var containing string.
searchChar
The Character to seek.
Can be instance of MfChar or string var containing character.
startIndex
An integer representing the starting position of the search.
Can be MfInteger instance or var containing integer.
true if the searchChar parameter occurs within strMain, or if searchChar CharCode equals 0; otherwise, false.
Static Method
See Example
Reports if there is an occurrence of a character specified by searchChar within strMain. The search starts at a character specified by startIndex position and examines a number of character positions specified by count.
strMain
The main String to search for last index of specified parameters.
Can be MfString instance or var containing string.
searchChar
The Character to seek.
Can be instance of MfChar or string var containing character.
startIndex
an integer representing the starting position of the search.
Can be MfInteger instance or var containing integer.
count
An integer representing the number of character positions to examine.
Can be MfInteger instance or var containing integer.
true if the searchChar parameter occurs within strMain, or if searchChar CharCode equals 0; otherwise, false.
Static Method
See Example
Reports if there is an occurrence of a string specified by strSearch within strMain.
strMain
The main String to search for last index of specified parameters.
Can be MfString instance or var containing string.
strSearch
The string to seek.
Can be MfString instance or var containing string.
true if the strSearch parameter occurs within strMain, or if strSearch is the empty string (""); otherwise, false.
Static Method
See Example
Reports if there is an occurrence of a string specified by strSearch within strMain. The search starts at character position specified by startIndex.
strMain
The main String to search for last index of specified parameters.
Can be MfString instance or var containing string.
strSearch
The string to seek.
Can be MfString instance or var containing string.
startIndex
An integer representing the starting position of the search.
Can be MfInteger instance or var containing integer.
true if the strSearch parameter occurs within strMain, or if strSearch is the empty string (""); otherwise, false.
Static Method
See Example
Reports if there is an occurrence of a string specified by strSearch within strMain. The search starts at character position specified by startIndex and examines a number of character positions specified by count.
strMain
The main String to search for last index of specified parameters.
Can be MfString instance or var containing string.
strSearch
The string to seek.
Can be MfString instance or var containing string.
startIndex
An integer representing the starting position of the search.
Can be MfInteger instance or var containing integer.
count
An integer representing the number of character positions to examine.
Can be MfInteger instance or var containing integer.
true if the strSearch parameter occurs within strMain, or if strSearch is the empty string (""); otherwise, false.
Static Method
See Example
Since Version 0.4
Index numbering starts from 0 (zero).
Method is not affected ReturnAsObject Property.
Overloads method supports using all vars or all objects. Mixing of vars and Objects is supported for this method.
Instance methods will obey IgnoreCase property. For static methods if strMain is an instance of MfString then the IgnoreCase property of that instance is used. If strMain is a var then case is ignored unless AutoHotkey built in variable A_StringCaseSense value is set to On by using AutoHotkeys StringCaseSense command.
Variadic Method; This method is Variadic so you may construct an instance of MfParams containing any of the overload method parameters listed above and pass in the MfParams instance to the method instead of using the overloads described above. See MfParams for more information.
Throws MfNotSupportedException if Overloads can not match Parameters.
Throws MfNullReferenceException if MfString is not an instance.
Throws MfArgumentException if there is an error get a value from a parameter.
Throws MfArgumentOutOfRangeException if startIndex is out of range.
; Static Examples
str := "Now is the time for all good men to come to the aid of their party."
MsgBox % MfString.Contains(str, "he") ; displays 1 for true
MsgBox % MfString.Contains(str, ".") ; displays 1 for true
MsgBox % MfString.Contains(str, "he", 44) ; displays 1 for true
MsgBox % MfString.Contains(str, "he", 54, 10) ; displays 1 for true
strMain := new MfString(str)
strMain.IgnoreCase := true
searchStr := new MfString("He")
startIndex := new MfInteger(54)
count := new MfInteger(10)
MsgBox % MfString.Contains(strMain, searchStr, startIndex, count) ; displays 0 for false
strMain.IgnoreCase := false
MsgBox % MfString.Contains(strMain, searchStr, startIndex, count) ; displays 1 for true
MsgBox % MfString.Contains(str, "He") ; displays 0 for false
StringCaseSense, On
MsgBox % MfString.Contains(str, "He") ; displays 1 for true
StringCaseSense, Off
; instance method examples
str := new MfString("Now is the time for all good men to come to the aid of their party.")
MsgBox % str.Contains("") ; displays 1 for true
MsgBox % str.Contains("he") ; displays 1 for true
MsgBox % str.Contains(new MfChar(".")) ; displays 1 for true
MsgBox % str.Contains(".") ; displays 1 for true
MsgBox % str.Contains("he", 44) ; displays 1 for true
MsgBox % str.Contains("he", 54, 10) ; displays 1 for true
MsgBox % str.Contains("He") ; displays 0 for false
str.IgnoreCase := false
MsgBox % str.Contains("He") ; displays 1 for true
searchStr := new MfString("he")
startIndex := new MfInteger(54)
count := new MfInteger(10)
MsgBox % str.Contains(searchStr, startIndex, count) ; displays 1 for true