pcre_get_substring_list(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | COLOPHON

PCRE_GET_SUBSTRING_LIST(3)brary Functions ManualRE_GET_SUBSTRING_LIST(3)

NAME         top

       PCRE - Perl-compatible regular expressions

SYNOPSIS         top


       #include <pcre.h>

       int pcre_get_substring_list(const char *subject,
            int *ovector, int stringcount, const char ***listptr);

       int pcre16_get_substring_list(PCRE_SPTR16 subject,
            int *ovector, int stringcount, PCRE_SPTR16 **listptr);

       int pcre32_get_substring_list(PCRE_SPTR32 subject,
            int *ovector, int stringcount, PCRE_SPTR32 **listptr);

DESCRIPTION         top


       This is a convenience function for extracting a list of all the
       captured substrings. The arguments are:

         subject       Subject that has been successfully matched
         ovector       Offset vector that pcre[16|32]_exec used
         stringcount   Value returned by pcre[16|32]_exec
         listptr       Where to put a pointer to the list

       The memory in which the substrings and the list are placed is
       obtained by calling pcre[16|32]_malloc(). The convenience
       function pcre[16|32]_free_substring_list() can be used to free it
       when it is no longer needed. A pointer to a list of pointers is
       put in the variable whose address is in listptr. The list is
       terminated by a NULL pointer. The yield of the function is zero
       on success or PCRE_ERROR_NOMEMORY if sufficient memory could not
       be obtained.

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