pcre2_substring_length_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_length_bynumber(pcre2_match_data *match_data,
         uint32_t number, PCRE2_SIZE *length);

DESCRIPTION top


       This function returns the length of a matched substring,
       identified by number.  The arguments are:

         match_data   The match data block for the match
         number       The substring number
         length       Where to return the length, or NULL

       The third argument may be NULL if all you want to know is whether
       or not a substring is set. The yield is zero on success, or a
       negative error code otherwise. After a partial match, only
       substring 0 is available.

       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              22 December 2014     PCRE2_SU..._BYNUMBER(3)