1<html> 2<head> 3<title>pcre2_get_error_message specification</title> 4</head> 5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6<h1>pcre2_get_error_message man page</h1> 7<p> 8Return to the <a href="index.html">PCRE2 index page</a>. 9</p> 10<p> 11This page is part of the PCRE2 HTML documentation. It was generated 12automatically from the original man page. If there is any nonsense in it, 13please consult the man page, in case the conversion went wrong. 14<br> 15<br><b> 16SYNOPSIS 17</b><br> 18<P> 19<b>#include <pcre2.h></b> 20</P> 21<P> 22<b>int pcre2_get_error_message(int <i>errorcode</i>, PCRE2_UCHAR *<i>buffer</i>,</b> 23<b> PCRE2_SIZE <i>bufflen</i>);</b> 24</P> 25<br><b> 26DESCRIPTION 27</b><br> 28<P> 29This function provides a textual error message for each PCRE2 error code. 30Compilation errors are positive numbers; UTF formatting errors and matching 31errors are negative numbers. The arguments are: 32<pre> 33 <i>errorcode</i> an error code (positive or negative) 34 <i>buffer</i> where to put the message 35 <i>bufflen</i> the length of the buffer (code units) 36</pre> 37The function returns the length of the message in code units, excluding the 38trailing zero, or the negative error code PCRE2_ERROR_NOMEMORY if the buffer is 39too small. In this case, the returned message is truncated (but still with a 40trailing zero). If <i>errorcode</i> does not contain a recognized error code 41number, the negative value PCRE2_ERROR_BADDATA is returned. 42</P> 43<P> 44There is a complete description of the PCRE2 native API in the 45<a href="pcre2api.html"><b>pcre2api</b></a> 46page and a description of the POSIX API in the 47<a href="pcre2posix.html"><b>pcre2posix</b></a> 48page. 49<p> 50Return to the <a href="index.html">PCRE2 index page</a>. 51</p> 52