pcre2_substring_get_bynumber(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

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

NAME top

       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS top


       #include <pcre2.h>

       int pcre2_substring_get_bynumber(pcre2_match_data *match_data,
         uint32_t number, PCRE2_UCHAR **bufferptr, PCRE2_SIZE *bufflen);

DESCRIPTION top


       This is a convenience function for extracting a captured
       substring by number into newly acquired memory. The arguments
       are:

         match_data    The match data for the match
         number        Number of the required substring
         bufferptr     Where to put the string pointer
         bufflen       Where to put the string length

       The memory in which the substring is placed is obtained by
       calling the same memory allocation function that was used for the
       match data block. The convenience function pcre2_substring_free()
       can be used to free it when it is no longer needed. The yield of
       the function is zero for success or one of the following error
       numbers:

         PCRE2_ERROR_NOSUBSTRING   there are no groups of that number
         PCRE2_ERROR_UNAVAILBLE    the ovector was too small for that
       group
         PCRE2_ERROR_UNSET         the group did not participate in the
       match
         PCRE2_ERROR_NOMEMORY      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 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 man-pages@man7.org

PCRE2 10.00                 13 December 2014      PCRE2_SU...BYNUMBER(3)