blob: 9ff53420de918ec96380529d45dd885424b147f9 [file] [log] [blame]
.TH PCRE2_GET_ERROR_MESSAGE 3 "21 October 2014" "PCRE2 10.00"
PCRE2 - Perl-compatible regular expressions (revised API)
.B #include <pcre2.h>
.B int pcre2_get_error_message(int \fIerrorcode\fP, PCRE2_UCHAR *\fIbuffer\fP,
.B " PCRE2_SIZE \fIbufflen\fP);"
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:
\fIerrorcode\fP an error code (positive or negative)
\fIbuffer\fP where to put the message
\fIbufflen\fP the length of the buffer (code units)
The function returns the length of the message, excluding the trailing zero, or
a negative error code if the buffer is too small.
There is a complete description of the PCRE2 native API in the
.\" HREF
page and a description of the POSIX API in the
.\" HREF