pcre2_get_error_message(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

PCRE2_GE...R_MESSAGE(3) Library Functions Manual PCRE2_GE...R_MESSAGE(3)

NAME top

       PCRE2 - Perl-compatible regular expressions (revised API)

SYNOPSIS top


       #include <pcre2.h>

       int pcre2_get_error_message(int errorcode, PCRE2_UCHAR *buffer,
         PCRE2_SIZE bufflen);

DESCRIPTION top


       This function provides a textual error message for each PCRE2
       error code.  Compilation errors are positive numbers; UTF
       formatting errors and matching errors are negative numbers. The
       arguments are:

         errorcode   an error code (positive or negative)
         buffer      where to put the message
         bufflen     the length of the buffer (code units)

       The function returns the length of the message in code units,
       excluding the trailing zero, or the negative error code
       PCRE2_ERROR_NOMEMORY if the buffer is too small. In this case,
       the returned message is truncated (but still with a trailing
       zero). If errorcode does not contain a recognized error code
       number, the negative value PCRE2_ERROR_BADDATA is returned.

       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 [email protected]

PCRE2 10.30                   24 March 2017      PCRE2_GE...R_MESSAGE(3)