pcre_get_stringnumber(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

PCRE_GET_STRINGNUMBER(3)Library Functions ManualPCRE_GET_STRINGNUMBER(3)

NAME top

       PCRE - Perl-compatible regular expressions

SYNOPSIS top


       #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 top


       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.

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 pcre-8.45.tar.gz fetched from
       ⟨ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/⟩ on
       2021-08-27.  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

PCRE 8.30                     24 June 2012      PCRE_GET_STRINGNUMBER(3)