Group Number From Name(String) Method
Returns the group number that corresponds to the specified group name.
public: int GroupNumberFromName(System::String ^ name);
public int GroupNumberFromName (string name);
member this.GroupNumberFromName : string -> int
Public Function GroupNumberFromName (name As String) As Integer
The group name to convert to the corresponding group number.
The group number that corresponds to the specified group name, or -1 if
name is not a valid group name.
A regular expression pattern may contain either named or numbered capturing groups, which delineate subexpressions within a pattern match. Numbered groups are delimited by the syntax (subexpression) and are assigned numbers based on their order in the regular expression. Named groups are delimited by the syntax (?
>subexpression) or (?'name'subexpression), where name is the name by which the subexpression will be identified. (For more information, see Grouping Constructs.) The GroupNumberFromName method identifies both named groups and numbered groups by their ordinal positions in the regular expression. Ordinal position zero always represents the entire regular expression. All numbered groups are then counted before named groups, regardless of their actual position in the regular expression pattern.
name is the string representation of a group number that is present in the regular expression pattern, the method returns that number. If
name corresponds to a named capturing group that is present in the regular expression pattern, the method returns its corresponding number. The comparison of
name with the group name is case-sensitive. If
name does not correspond to the name of a capturing group or to the string representation of the number of a capturing group, the method returns -1.