pcre2_next_match(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

PCRE2_NEXT_MATCH(3)      Library Functions Manual     PCRE2_NEXT_MATCH(3)

NAME top

       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS top


       #include <pcre2.h>

       int pcre2_next_match(pcre2_match_data *match_data,
         PCRE2_SIZE *pstart_offset, uint32_t *poptions);

DESCRIPTION top


       This function can be called after one of the match functions
       (pcre2_match(), pcre2_dfa_match(), or pcre2_jit_match()), and must
       be provided with the same match_data parameter. It outputs the
       appropriate parameters for searching for the next match in the
       same subject string, and is suitable for applications providing
       "global" matching behaviour (for example, replacing all matches in
       the subject, or splitting the subject on all matches, or simply
       counting the number of matches).

       It returns 0 ("false") if there is no need to make any further
       match attempts, or 1 ("true") if another match should be
       attempted.

       The *pstart_offset and *poptions are set if the function returns
       1.  The *pstart_offset should be passed to the next match attempt
       directly, and the *poptions should be passed to the next match
       attempt by combining with the application's match options using
       OR.

       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               01 March 2025           PCRE2_NEXT_MATCH(3)