Regex.Match Method (String, Int32, Int32)
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Searches the input string for the first occurrence of a regular expression with a specified input string starting position and input string length.
Namespace: System.Text.RegularExpressions
Assembly: System (in System.dll)
Syntax
'Declaration
Public Function Match ( _
input As String, _
beginning As Integer, _
length As Integer _
) As Match
public Match Match(
string input,
int beginning,
int length
)
Parameters
- input
Type: System.String
The string to search for a match.
- beginning
Type: System.Int32
The zero-based character position in the input string that defines the leftmost position to be searched.
- length
Type: System.Int32
The number of characters in the substring to include in the search.
Return Value
Type: System.Text.RegularExpressions.Match
An object that contains information about the match.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | input is nulla null reference (Nothing in Visual Basic). |
| ArgumentOutOfRangeException | beginning is less than zero or greater than the length of input. -or- length is less than zero or greater than the length of input. -or- beginning+length– 1 identifies a position that is outside the range of input. |
Remarks
The regular expression pattern for which the Regex.Match(String, Int32, Int32) method searches is defined by the call to one of the Regex class constructors. For more information about the elements that can form a regular expression pattern, see Regular Expression Language Elements in the .NET Framework documentation.
This 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. 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 RegexOptions.RightToLeft option so that the search proceeds from right to left, the regular expression engine searches from the character at index beginning+length– 1 to the character at index beginning. This method returns the first match that it finds within this range. You can retrieve subsequent matches by repeatedly calling the returned Match object's Match.NextMatch method.
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 successful, 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.
Version Information
Silverlight
Supported in: 5, 4, 3
Silverlight for Windows Phone
Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0
XNA Framework
Supported in: Xbox 360, Windows Phone OS 7.0
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
See Also