pcre2_substring_nametable_scan(3) — Linux manual page

PCRE2_SU...BLE_SCAN(3)  Library Functions Manual  PCRE2_SU...BLE_SCAN(3)

NAME

       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS

       #include <pcre2.h>

       int pcre2_substring_nametable_scan(const pcre2_code *code,
         PCRE2_SPTR name, PCRE2_SPTR *first, PCRE2_SPTR *last);

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
         name    Name whose entries required
         first   Where to return a pointer to the first entry
         last    Where to return a pointer to the last entry

       When the name is found in the table, if first 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
       pointers 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.

       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.

COLOPHON

       This page is part of the PCRE (Perl Compatible Regular
       Expressions) project.  Information about the project can be found
       at ⟨http://www.pcre.org/⟩.  If you have a bug report for this
       manual page, see
       ⟨http://bugs.exim.org/enter_bug.cgi?product=PCRE⟩.  This page was
       obtained from the tarball fetched from
       ⟨https://github.com/PhilipHazel/pcre2.git⟩ on 2024-06-14.  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

PCRE2 10.33                 03 February 2019      PCRE2_SU...BLE_SCAN(3)