Export (0) Print
Expand All

Regex::Match Method (String, String, RegexOptions)

Searches the input string for the first occurrence of the specified regular expression, using the specified matching options.

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

static Match^ Match(
	String^ input, 
	String^ pattern, 
	RegexOptions options


Type: System::String

The string to search for a match.

Type: System::String

The regular expression pattern to match.

Type: System.Text.RegularExpressions::RegexOptions

A bitwise combination of the enumeration values that provide options for matching.

Return Value

Type: System.Text.RegularExpressions::Match
An object that contains information about the match.


A regular expression parsing error occurred.


input or pattern is nullptr.


options is not a valid bitwise combination of RegexOptions values.


A time-out occurred. For more information about time-outs, see the Remarks section.

The Match(String, String, RegexOptions) method returns the first substring that matches a regular expression pattern in an input string. For information about the language elements used to build a regular expression pattern, see Regular Expression Language - Quick Reference.

The static Match(String, String, RegexOptions) method is equivalent to constructing a Regex object with the Regex(String, RegexOptions) constructor and calling the instance Match(String) method.

The pattern parameter consists of regular expression language elements that symbolically describe the string to match. For more information about regular expressions, see .NET Framework Regular Expressions and Regular Expression Language - Quick Reference.

You can determine whether the regular expression pattern has been found in the input string by checking the value of the returned Match object's Success property. If a match is found, the returned Match object's Value property contains the substring from input that matches the regular expression pattern. If no match is found, its value is String::Empty.

This method returns the first substring found in input that matches the regular expression pattern. You can retrieve subsequent matches by repeatedly calling the returned Match object's NextMatch method. You can also retrieve all matches in a single method call by calling the Regex::Matches(String, String, RegexOptions) method.

The RegexMatchTimeoutException exception is thrown if the execution time of the matching operation exceeds the time-out interval specified for the application domain in which the method is called. If no time-out is defined in the application domain's properties, or if the time-out value is Regex::InfiniteMatchTimeout, no exception is thrown.

Notes to Callers

This method times out after an interval that is equal to the default time-out value of the application domain in which it is called. If a time-out value has not been defined for the application domain, the value Regex::InfiniteMatchTimeout, which prevents the method from timing out, is used. The recommended static method for retrieving a pattern match is Regex::Match(String, String), which lets you set the time-out interval.

The following example defines a regular expression that matches words beginning with the letter "a". It uses the RegexOptions::IgnoreCase option to ensure that the regular expression locates words beginning with both an uppercase "a" and a lowercase "a".

No code example is currently available or this language may not be supported.

The regular expression pattern \ba\w*\b is interpreted as shown in the following table.




Begin the match at a word boundary.


Match the character "a".


Match zero, one, or more word characters.


End the match at a word boundary.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

© 2014 Microsoft