---
name: "pcre2_substring_number_from_name"
section: "3"
platform: "linux"
package: "pcre2"
version: "10.49-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/pcre2_substring_number_from_name"
---

# pcre2\_substring\_number\_from\_name(3)

Perl-compatible regular expressions (revised API)

## NAME

PCRE2 - Perl-compatible regular expressions (revised API)

## SYNOPSIS

**#include \<pcre2.h\>**

```
int pcre2_substring_number_from_name(const pcre2_code *code,
  PCRE2_SPTR name);
```

## DESCRIPTION

This convenience function finds the number of a named substring capturing parenthesis in a compiled pattern, provided that it is a unique name. The function arguments are:

  *code*    Compiled regular expression\
   *name*    Name whose number is required

The yield of the function is the number of the parenthesis if the name is found, or PCRE2\_ERROR\_NOSUBSTRING if it is not found. When duplicate names are allowed (PCRE2\_DUPNAMES is set), if the name is not unique, PCRE2\_ERROR\_NOUNIQUESUBSTRING is returned. You can obtain the list of numbers with the same name by calling **pcre2\_substring\_nametable\_scan()**.

There is a complete description of the PCRE2 native API in the **pcre2api** page and a description of the POSIX API in the **pcre2posix** page.