PCRE\_GET\_STRINGNUMBER(3) Library Functions Manual PCRE\_GET\_STRINGNUMBER(3)

# [NAME](#NAME)

PCRE - Perl-compatible regular expressions

# [SYNOPSIS](#SYNOPSIS)

**#include <pcre.h>**

```
int pcre_get_stringnumber(const pcre *code,
     const char *name);

int pcre16_get_stringnumber(const pcre16 *code,
     PCRE_SPTR16 name);

int pcre32_get_stringnumber(const pcre32 *code,
     PCRE_SPTR32 name);
```

# [DESCRIPTION](#DESCRIPTION)

This convenience function finds the number of a named substring capturing parenthesis in a compiled pattern. Its 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 PCRE\_ERROR\_NOSUBSTRING otherwise. When duplicate names are allowed (PCRE\_DUPNAMES is set), it is not defined which of the numbers is returned by **pcre\[16|32]\_get\_stringnumber()**. You can obtain the complete list by calling **pcre\[16|32]\_get\_stringtable\_entries()**.

There is a complete description of the PCRE native API in the **pcreapi** page and a description of the POSIX API in the **pcreposix** page.

24 June 2012 PCRE 8.30

---

Document: pcre16_get_stringnumber(3) from pcre 8.45-r11 (Chainguard OS)
Source: https://downloads.sourceforge.net/project/pcre/pcre/8.45/pcre-8.45.tar.bz2