pcre2_get_error_message - man pages section 3: Library Interfaces and Headers

Language:

pcre2_get_error_message (3)

Name

pcre2_get_error_message - compatible regular expressions (revised API)

Synopsis

#include <pcre2.h>

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

Description

Library Functions Manual                            PCRE2_GET_ERROR_MESSAGE(3)



NAME
       PCRE2 - Perl-compatible regular expressions (revised API)

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)
         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 trun-
       cated (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.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/pcre2    |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source      was     downloaded     from      https://github.com/Philip-
       Hazel/pcre2/releases/download/pcre2-10.39/pcre2-10.39.tar.gz.

       Further information about this software can be found on the open source
       community website at http://pcre.org/.



PCRE2 10.30                      24 March 2017
                                                    PCRE2_GET_ERROR_MESSAGE(3)