pcre2_substring_list_get(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

PCRE2_SUB..._LIST_GET(3) Library Functions ManualPCRE2_SUB..._LIST_GET(3)

NAME top

       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS top


       #include <pcre2.h>

       int pcre2_substring_list_get(pcre2_match_data *match_data,
         PCRE2_UCHAR ***listptr, PCRE2_SIZE **lengthsptr);

DESCRIPTION top


       This is a convenience function for extracting all the captured
       substrings after a pattern match. It builds a list of pointers to
       the strings, and (optionally) a second list that contains their
       lengths (in code units), excluding a terminating zero that is
       added to each of them. All this is done in a single block of
       memory that is obtained using the same memory allocation function
       that was used to get the match data block. The convenience
       function pcre2_substring_list_free() can be used to free it when
       it is no longer needed. The arguments are:

         match_data    The match data block
         listptr       Where to put a pointer to the list
         lengthsptr    Where to put a pointer to the lengths, or NULL

       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.
       If lengthsptr is not NULL, a matching list of lengths is created,
       and its address is placed in lengthsptr. The yield of the function
       is zero on success or PCRE2_ERROR_NOMEMORY if sufficient memory
       could not be obtained.

       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 2025-08-11.  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.46-DEV              21 October 2014     PCRE2_SUB..._LIST_GET(3)