Share via


Matches Method (String, Int32)

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Searches the specified input string for all occurrences of a regular expression, beginning at the specified starting position in the string.

Namespace:  System.Text.RegularExpressions
Assembly:  System.Text.RegularExpressions (in System.Text.RegularExpressions.dll)

Syntax

'Declaration
Public Function Matches ( _
    input As String, _
    startat As Integer _
) As MatchCollection
public MatchCollection Matches(
    string input,
    int startat
)
public:
MatchCollection^ Matches(
    String^ input, 
    int startat
)
member Matches : 
        input:string * 
        startat:int -> MatchCollection 
public function Matches(
    input : String, 
    startat : int
) : MatchCollection

Parameters

  • startat
    Type: System. . :: . .Int32
    The character position in the input string at which to start the search.

Return Value

Type: System.Text.RegularExpressions. . :: . .MatchCollection
A collection of the Match objects found by the search. If no matches are found, the method returns an empty collection object.

Remarks

The Matches(String, Int32) method is similar to the Match(String, Int32) method, except that it returns information about all the matches found in the input string, instead of a single match.

The regular expression pattern for which the Matches(String, Int32) method searches is defined by the call to one of the Regex class constructors.

The Matches method uses lazy evaluation to populate the returned MatchCollection object. Accessing members of this collection such as MatchCollection..::..Count and MatchCollection..::..CopyTo causes the collection to be populated immediately. To take advantage of lazy evaluation, you should iterate the collection by using a construct such as foreach in C# and ForEach…Next in Visual Basic.

Because of its lazy evaluation, calling the Matches(String, Int32) method does not throw a RegexMatchTimeoutException exception. However, the exception is thrown when an operation is performed on the MatchCollection object returned by this method, if the MatchTimeout property is not Regex.InfiniteMatchTimeout and a matching operation exceeds the time-out interval..

.NET Framework Security

See Also

Reference

Regex Class

Matches Overload

System.Text.RegularExpressions Namespace