Regex.Match Method

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

public:
 System::Text::RegularExpressions::Match ^ Match(System::String ^ input);

public System.Text.RegularExpressions.Match Match(string input);

member this.Match : string -> System.Text.RegularExpressions.Match

Public Function Match (input As String) As Match

Parameters

Returns

An object that contains information about the match.

Exceptions

Remarks

The Match(String) method returns the first substring that matches a regular expression pattern in an input string.

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

This method returns the first match. 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 Matches(String).

The RegexMatchTimeoutException exception is thrown if the execution time of the matching operation exceeds the time-out interval specified by the Regex(String, RegexOptions, TimeSpan) constructor. If you do not set a time-out interval when you call the constructor, the exception is thrown if the operation exceeds any time-out value established for the application domain in which the Regex object is created. If no time-out is defined in the Regex constructor call or in the application domain's properties, or if the time-out value is InfiniteMatchTimeout, no exception is thrown.

See also

• NextMatch()
• Regular Expression Language - Quick Reference

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

public:
 System::Text::RegularExpressions::Match ^ Match(System::String ^ input, int startat);

public System.Text.RegularExpressions.Match Match(string input, int startat);

member this.Match : string * int -> System.Text.RegularExpressions.Match

Public Function Match (input As String, startat As Integer) As Match

Parameters

Returns

An object that contains information about the match.

Exceptions

Remarks

For more information about startat, see Supplemental API remarks for Regex.Match.

See also

• NextMatch()
• Regular Expression Language - Quick Reference

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

public:
 static System::Text::RegularExpressions::Match ^ Match(System::String ^ input, System::String ^ pattern);

public static System.Text.RegularExpressions.Match Match(string input, string pattern);

static member Match : string * string -> System.Text.RegularExpressions.Match

Public Shared Function Match (input As String, pattern As String) As Match

Parameters

Returns

An object that contains information about the match.

Exceptions

Remarks

The static Match(String, String) method is equivalent to constructing a Regex object with the specified pattern and calling the instance Match(String) method. The regular expression engine caches the pattern.

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

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 Matches(String, String) method.

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 InfiniteMatchTimeout, which prevents the method from timing out, is used. The recommended static method for retrieving a pattern match is Match(String, String), which lets you set the time-out interval.

See also

• NextMatch()
• Regular Expression Language - Quick Reference

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

public:
 System::Text::RegularExpressions::Match ^ Match(System::String ^ input, int beginning, int length);

public System.Text.RegularExpressions.Match Match(string input, int beginning, int length);

member this.Match : string * int * int -> System.Text.RegularExpressions.Match

Public Function Match (input As String, beginning As Integer, length As Integer) As Match

Parameters

Returns

An object that contains information about the match.

Exceptions

Remarks

The Match(String, Int32, Int32) method searches the portion of input defined by the beginning and length parameters for the regular expression pattern. beginning always defines the index of the leftmost character to include in the search, and length defines the maximum number of characters to search. Together, they define the range of the search. The behavior is exactly as if the input was effectively input.Substring(beginning, length), except that the index of any match is counted relative to the start of input. This means that any anchors or zero-width assertions at the start or end of the pattern behave as if there is no input outside of this range.

If the search proceeds from left to right (the default), the regular expression engine searches from the character at index beginning to the character at index beginning + length - 1. If the regular expression engine was instantiated by using the RightToLeft option, the engine searches from the character at index beginning + length - 1 to the character at index beginning.

This method returns the first match found within this range. You can retrieve subsequent matches by repeatedly calling the returned Match object's NextMatch() method.

See also

• NextMatch()
• Regular Expression Language - Quick Reference

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

public:
 static System::Text::RegularExpressions::Match ^ Match(System::String ^ input, System::String ^ pattern, System::Text::RegularExpressions::RegexOptions options);

public static System.Text.RegularExpressions.Match Match(string input, string pattern, System.Text.RegularExpressions.RegexOptions options);

static member Match : string * string * System.Text.RegularExpressions.RegexOptions -> System.Text.RegularExpressions.Match

Public Shared Function Match (input As String, pattern As String, options As RegexOptions) As Match

Parameters

Returns

An object that contains information about the match.

Exceptions

Remarks

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.

You can determine whether the regular expression pattern has been found in the input string by checking the returned Match object's Success property. 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 Matches(String, String, RegexOptions) method.

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 InfiniteMatchTimeout, which prevents the method from timing out, is used. The recommended static method for retrieving a pattern match is Match(String, String), which lets you set the time-out interval.

See also

• NextMatch()
• Regular Expression Language - Quick Reference

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

Source:

Regex.Match.cs

public:
 static System::Text::RegularExpressions::Match ^ Match(System::String ^ input, System::String ^ pattern, System::Text::RegularExpressions::RegexOptions options, TimeSpan matchTimeout);

public static System.Text.RegularExpressions.Match Match(string input, string pattern, System.Text.RegularExpressions.RegexOptions options, TimeSpan matchTimeout);

static member Match : string * string * System.Text.RegularExpressions.RegexOptions * TimeSpan -> System.Text.RegularExpressions.Match

Public Shared Function Match (input As String, pattern As String, options As RegexOptions, matchTimeout As TimeSpan) As Match

Parameters

Returns

An object that contains information about the match.

Exceptions

Remarks

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

You can determine whether the regular expression pattern has been found in the input string by checking the returned Match object's Success property. You can retrieve subsequent matches by repeatedly calling the returned Match object's NextMatch() method.

The matchTimeout parameter specifies how long a pattern matching method should try to find a match before it times out. Setting a time-out interval prevents regular expressions that rely on excessive backtracking from appearing to stop responding when they process input that contains near matches. If no match is found in that time interval, the method throws a RegexMatchTimeoutException exception. matchTimeout overrides any default time-out value defined for the application domain in which the method executes.

Notes to Callers

We recommend that you set the matchTimeout parameter to an appropriate value, such as two seconds. If you disable time-outs by specifying InfiniteMatchTimeout, the regular expression engine offers slightly better performance. However, you should disable time-outs only under the following conditions:

• When the input processed by a regular expression is derived from a known and trusted source or consists of static text. This excludes text that has been dynamically input by users.

• When the regular expression pattern has been thoroughly tested to ensure that it efficiently handles matches, non-matches, and near matches.

• When the regular expression pattern contains no language elements that are known to cause excessive backtracking when processing a near match.

See also

• Regular Expression Language - Quick Reference