man-pages/man3/pcre2_config.3.html
2021-03-31 01:06:50 +01:00

110 lines
6.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PCRE2_CONFIG</TITLE>
</HEAD><BODY>
<H1>PCRE2_CONFIG</H1>
Section: C Library Functions (3)<BR>Updated: 16 September 2017<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
PCRE2 - Perl-compatible regular expressions (revised API)
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<P>
<B>#include &lt;<A HREF="file:///usr/include/pcre2.h">pcre2.h</A>&gt;</B>
<P>
<FONT SIZE="-1"><B>int pcre2_config(uint32_t </B><I>what</I>, void *<I>where</I>);
</FONT>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
This function makes it possible for a client program to find out which optional
features are available in the version of the PCRE2 library it is using. The
arguments are as follows:
<P>
<BR>&nbsp;&nbsp;<I>what</I>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A&nbsp;code&nbsp;specifying&nbsp;what&nbsp;information&nbsp;is&nbsp;required
<BR>&nbsp;&nbsp;<I>where</I>&nbsp;&nbsp;&nbsp;&nbsp;Points&nbsp;to&nbsp;where&nbsp;to&nbsp;put&nbsp;the&nbsp;information
<P>
If <I>where</I> is NULL, the function returns the amount of memory needed for
the requested information. When the information is a string, the value is in
code units; for other types of data it is in bytes.
<P>
If <B>where</B> is not NULL, for PCRE2_CONFIG_JITTARGET,
PCRE2_CONFIG_UNICODE_VERSION, and PCRE2_CONFIG_VERSION it must point to a
buffer that is large enough to hold the string. For all other codes it must
point to a uint32_t integer variable. The available codes are:
<P>
<BR>&nbsp;&nbsp;PCRE2_CONFIG_BSR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates&nbsp;what&nbsp;\R&nbsp;matches&nbsp;by&nbsp;default:
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PCRE2_BSR_UNICODE
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PCRE2_BSR_ANYCRLF
<BR>&nbsp;&nbsp;PCRE2_CONFIG_COMPILED_WIDTHS&nbsp;Which&nbsp;of&nbsp;8/16/32&nbsp;support&nbsp;was&nbsp;compiled
<BR>&nbsp;&nbsp;PCRE2_CONFIG_DEPTHLIMIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default&nbsp;backtracking&nbsp;depth&nbsp;limit
<BR>&nbsp;&nbsp;PCRE2_CONFIG_HEAPLIMIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default&nbsp;heap&nbsp;memory&nbsp;limit
<BR>&nbsp;&nbsp;PCRE2_CONFIG_JIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Availability&nbsp;of&nbsp;just-in-time&nbsp;compiler
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;support&nbsp;(1=yes&nbsp;0=no)
<BR>&nbsp;&nbsp;PCRE2_CONFIG_JITTARGET&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Information&nbsp;(a&nbsp;string)&nbsp;about&nbsp;the&nbsp;target
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;architecture&nbsp;for&nbsp;the&nbsp;JIT&nbsp;compiler
<BR>&nbsp;&nbsp;PCRE2_CONFIG_LINKSIZE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Configured&nbsp;internal&nbsp;link&nbsp;size&nbsp;(2,&nbsp;3,&nbsp;4)
<BR>&nbsp;&nbsp;PCRE2_CONFIG_MATCHLIMIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default&nbsp;internal&nbsp;resource&nbsp;limit
<BR>&nbsp;&nbsp;PCRE2_CONFIG_NEVER_BACKSLASH_C&nbsp;&nbsp;Whether&nbsp;or&nbsp;not&nbsp;\C&nbsp;is&nbsp;disabled
<BR>&nbsp;&nbsp;PCRE2_CONFIG_NEWLINE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Code&nbsp;for&nbsp;the&nbsp;default&nbsp;newline&nbsp;sequence:
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PCRE2_NEWLINE_CR
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PCRE2_NEWLINE_LF
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PCRE2_NEWLINE_CRLF
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PCRE2_NEWLINE_ANY
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PCRE2_NEWLINE_ANYCRLF
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PCRE2_NEWLINE_NUL
<BR>&nbsp;&nbsp;PCRE2_CONFIG_PARENSLIMIT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default&nbsp;parentheses&nbsp;nesting&nbsp;limit
<BR>&nbsp;&nbsp;PCRE2_CONFIG_RECURSIONLIMIT&nbsp;&nbsp;Obsolete:&nbsp;use&nbsp;PCRE2_CONFIG_DEPTHLIMIT
<BR>&nbsp;&nbsp;PCRE2_CONFIG_STACKRECURSE&nbsp;&nbsp;&nbsp;&nbsp;Obsolete:&nbsp;always&nbsp;returns&nbsp;0
<BR>&nbsp;&nbsp;PCRE2_CONFIG_UNICODE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Availability&nbsp;of&nbsp;Unicode&nbsp;support&nbsp;(1=yes
<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;0=no)
<BR>&nbsp;&nbsp;PCRE2_CONFIG_UNICODE_VERSION&nbsp;The&nbsp;Unicode&nbsp;version&nbsp;(a&nbsp;string)
<BR>&nbsp;&nbsp;PCRE2_CONFIG_VERSION&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;PCRE2&nbsp;version&nbsp;(a&nbsp;string)
<P>
The function yields a non-negative value on success or the negative value
PCRE2_ERROR_BADOPTION otherwise. This is also the result for the
PCRE2_CONFIG_JITTARGET code if JIT support is not available. When a string is
requested, the function returns the number of code units used, including the
terminating zero.
<P>
There is a complete description of the PCRE2 native API in the
<B>pcre2api</B>
page and a description of the POSIX API in the
<B>pcre2posix</B>
page.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:49 GMT, March 31, 2021
</BODY>
</HTML>