pcre2_get_error_message

PCRE2 10.50-DEV manual; updated

Synopsis

#include <pcre2.h>

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

Description

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), or zero for no error
buffer
where to put the message; may be NULL only when bufflen is zero
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, assuming bufflen is not zero). With a recognized code and zero capacity, no output is written and PCRE2_ERROR_NOMEMORY is returned.

If errorcode is neither zero nor a recognized error code number, the negative value PCRE2_ERROR_BADDATA is returned without changing the buffer, even when bufflen is zero.

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.