Regex.GroupNumberFromName(String) Метод

Определение

Возвращает номер группы, соответствующий указанному имени группы.

public:
 int GroupNumberFromName(System::String ^ name);
public int GroupNumberFromName(string name);
member this.GroupNumberFromName : string -> int
Public Function GroupNumberFromName (name As String) As Integer

Параметры

name
String

Имя группы для преобразования в соответствующий номер группы.

Возвращаемое значение

Номер группы, соответствующий указанному имени группы или -1, если name не является допустимым именем группы.

Исключения

name равно null.

Комментарии

Шаблон регулярного выражения может содержать как именованные, так и нумерованные группы записи, которые обозначают вложенные выражения в соответствии с шаблоном. Нумерованные группы разделены синтаксисом (вложенным выражением) и назначаются числа на основе их порядка в регулярном выражении. Именованные группы разделены синтаксисом (?<Имя>subexpression) или (? name'subexpression), где имя — это имя, по которому будет определяться подтекст. (Дополнительные сведения см. в разделе "Конструкции группирования".) Метод GroupNumberFromName определяет именованные группы и нумерованные группы по порядковой позиции в регулярном выражении. Порядковое положение ноль всегда представляет все регулярное выражение. Затем все нумерованные группы учитываются до именованных групп независимо от их фактической позиции в шаблоне регулярного выражения.

Если name строковое представление номера группы, присутствующих в шаблоне регулярного выражения, метод возвращает это число. Если name соответствует именованной группе записи, которая присутствует в шаблоне регулярного выражения, метод возвращает соответствующее число. Сравнение name с именем группы учитывает регистр. Если name имя группы записи не соответствует или строковому представлению числа записывающего группы, метод возвращает значение -1.

Применяется к

См. также раздел