pcre2_substring_number_from_name(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

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

NAME top

       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS top


       #include <pcre2.h>

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

DESCRIPTION top


       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.

COLOPHON top

       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 [email protected]

PCRE2 10.00                  21 October 2014      PCRE2_SU...ROM_NAME(3)