pcre2_substring_nametable_scan

PCRE2 10.50-DEV manual; updated

Synopsis

#include <pcre2.h>

int pcre2_substring_nametable_scan(const pcre2_code *code,
                                   PCRE2_SPTR stringname,
                                   PCRE2_SPTR *firstptr,
                                   PCRE2_SPTR *lastptr);

Description

This convenience function finds, for a compiled pattern, the first and last entries for a given name in the table that translates capture group names into numbers.

code
Compiled regular expression
stringname
Name whose entries required
firstptr
Where to return a pointer to the first entry
lastptr
Where to return a pointer to the last entry

When the name is found in the table, if firstptr is NULL, the function returns a group number, but if there is more than one matching entry, it is not defined which one. Otherwise, when both firstptr and lastptr have been set, the yield of the function is the length of each entry in code units. If the name is not found, PCRE2_ERROR_NOSUBSTRING is returned.

If firstptr is not NULL, lastptr must not be NULL.

There is a complete description of the PCRE2 native API, including the format of the table entries, in the pcre2api page, and a description of the POSIX API in the pcre2posix page.