Match Class

Definition

public ref class Match : System::Text::RegularExpressions::Group

public class Match : System.Text.RegularExpressions.Group

[System.Serializable]
public class Match : System.Text.RegularExpressions.Group

type Match = class
    inherit Group

[<System.Serializable>]
type Match = class
    inherit Group

Public Class Match
Inherits Group

Inheritance

Object

Capture

Group

Match

Attributes

SerializableAttribute

Remarks

The Match class is immutable and has no public constructor. An instance of the Match class is returned by the Match(String) method and represents the first pattern match in a string. Subsequent matches are represented by Match objects returned by the NextMatch() method. In addition, a MatchCollection object that consists of zero, one, or more Match objects is returned by the Matches(String) method.

If the Matches(String) method fails to match a regular expression pattern in an input string, it returns an empty MatchCollection object. You can then use a foreach construct to iterate over the collection.

If the Match(String) method fails to match the regular expression pattern, it returns a Match object that is equal to Empty. You can use the Success property to determine whether the match was successful.

If a pattern match is successful, the Value property contains the matched substring, the Index property indicates the zero-based starting position of the matched substring in the input string, and the Length property indicates the length of the matched substring in the input string.

Because a single match can involve multiple capturing groups, Match has a Groups property that returns the GroupCollection. The Match instance itself is equivalent to the first object in the collection, at Match.Groups[0], which represents the entire match.

See also

• MatchCollection
• Regex