pcre_get_named_substring(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

PCRE_GET_NAMED_SUBSTRING(3)rary Functions ManualE_GET_NAMED_SUBSTRING(3)

NAME top

       PCRE - Perl-compatible regular expressions

SYNOPSIS top


       #include <pcre.h>

       int pcre_get_named_substring(const pcre *code,
            const char *subject, int *ovector,
            int stringcount, const char *stringname,
            const char **stringptr);

       int pcre16_get_named_substring(const pcre16 *code,
            PCRE_SPTR16 subject, int *ovector,
            int stringcount, PCRE_SPTR16 stringname,
            PCRE_SPTR16 *stringptr);

       int pcre32_get_named_substring(const pcre32 *code,
            PCRE_SPTR32 subject, int *ovector,
            int stringcount, PCRE_SPTR32 stringname,
            PCRE_SPTR32 *stringptr);

DESCRIPTION top


       This is a convenience function for extracting a captured
       substring by name. The arguments are:

         code          Compiled pattern
         subject       Subject that has been successfully matched
         ovector       Offset vector that pcre[16|32]_exec() used
         stringcount   Value returned by pcre[16|32]_exec()
         stringname    Name of the required substring
         stringptr     Where to put the string pointer

       The memory in which the substring is placed is obtained by
       calling pcre[16|32]_malloc(). The convenience function
       pcre[16|32]_free_substring() can be used to free it when it is no
       longer needed. The yield of the function is the length of the
       extracted substring, PCRE_ERROR_NOMEMORY if sufficient memory
       could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string
       name is invalid.

       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_NAMED_SUBSTRING(3)