doc/html/pcre_config.html

<html>
<head>
<title>pcre_config specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre_config man page</h1>
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
<p>
This page is part of the PCRE HTML documentation. It was generated automatically
from the original man page. If there is any nonsense in it, please consult the
man page, in case the conversion went wrong.
<br>
<br><b>
SYNOPSIS
</b><br>
<P>
<b>#include &#60;pcre.h&#62;</b>
</P>
<P>
<b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
</P>
<P>
<b>int pcre16_config(int <i>what</i>, void *<i>where</i>);</b>
</P>
<P>
<b>int pcre32_config(int <i>what</i>, void *<i>where</i>);</b>
</P>
<br><b>
DESCRIPTION
</b><br>
<P>
This function makes it possible for a client program to find out which optional
features are available in the version of the PCRE library it is using. The
arguments are as follows:
<pre>
  <i>what</i>     A code specifying what information is required
  <i>where</i>    Points to where to put the data
</pre>
The <i>where</i> argument must point to an integer variable, except for
PCRE_CONFIG_MATCH_LIMIT and PCRE_CONFIG_MATCH_LIMIT_RECURSION, when it must
point to an unsigned long integer. The available codes are:
<pre>
  PCRE_CONFIG_JIT           Availability of just-in-time compiler
                              support (1=yes 0=no)
  PCRE_CONFIG_JITTARGET     String containing information about the
                              target architecture for the JIT compiler,
                              or NULL if there is no JIT support
  PCRE_CONFIG_LINK_SIZE     Internal link size: 2, 3, or 4
  PCRE_CONFIG_MATCH_LIMIT   Internal resource limit
  PCRE_CONFIG_MATCH_LIMIT_RECURSION
                            Internal recursion depth limit
  PCRE_CONFIG_NEWLINE       Value of the default newline sequence:
                                13 (0x000d)    for CR
                                10 (0x000a)    for LF
                              3338 (0x0d0a)    for CRLF
                                -2             for ANYCRLF
                                -1             for ANY
  PCRE_CONFIG_BSR           Indicates what \R matches by default:
                                 0             all Unicode line endings
                                 1             CR, LF, or CRLF only
  PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
                            Threshold of return slots, above which
                              <b>malloc()</b> is used by the POSIX API
  PCRE_CONFIG_STACKRECURSE  Recursion implementation (1=stack 0=heap)
  PCRE_CONFIG_UTF16         Availability of UTF-16 support (1=yes
                               0=no); option for <b>pcre16_config()</b>
  PCRE_CONFIG_UTF32         Availability of UTF-32 support (1=yes
                               0=no); option for <b>pcre32_config()</b>
  PCRE_CONFIG_UTF8          Availability of UTF-8 support (1=yes 0=no);
                              option for <b>pcre_config()</b>
  PCRE_CONFIG_UNICODE_PROPERTIES
                            Availability of Unicode property support
                              (1=yes 0=no)
</pre>
The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
is also given if PCRE_CONFIG_UTF16 or PCRE_CONFIG_UTF32 is passed to
<b>pcre_config()</b>, if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF32 is passed to
<b>pcre16_config()</b>, or if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF16 is passed to
<b>pcre32_config()</b>.
</P>
<P>
There is a complete description of the PCRE native API in the
<a href="pcreapi.html"><b>pcreapi</b></a>
page and a description of the POSIX API in the
<a href="pcreposix.html"><b>pcreposix</b></a>
page.
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
1	nigel	63	<html>
2			<head>
3			<title>pcre_config specification</title>
4			</head>
5			<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6	nigel	75	<h1>pcre_config man page</h1>
7			<p>
8			Return to the <a href="index.html">PCRE index page</a>.
9			</p>
10	ph10	111	<p>
11	nigel	75	This page is part of the PCRE HTML documentation. It was generated automatically
12			from the original man page. If there is any nonsense in it, please consult the
13			man page, in case the conversion went wrong.
14	ph10	111	<br>
15	nigel	63	<br><b>
16			SYNOPSIS
17			</b><br>
18			<P>
19			<b>#include <pcre.h></b>
20			</P>
21			<P>
22			<b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
23			</P>
24	ph10	869	<P>
25			<b>int pcre16_config(int <i>what</i>, void *<i>where</i>);</b>
26			</P>
27	ph10	1194	<P>
28			<b>int pcre32_config(int <i>what</i>, void *<i>where</i>);</b>
29			</P>
30	nigel	63	<br><b>
31			DESCRIPTION
32			</b><br>
33			<P>
34			This function makes it possible for a client program to find out which optional
35	ph10	691	features are available in the version of the PCRE library it is using. The
36	nigel	63	arguments are as follows:
37			<pre>
38			<i>what</i> A code specifying what information is required
39			<i>where</i> Points to where to put the data
40	nigel	75	</pre>
41	ph10	691	The <i>where</i> argument must point to an integer variable, except for
42			PCRE_CONFIG_MATCH_LIMIT and PCRE_CONFIG_MATCH_LIMIT_RECURSION, when it must
43			point to an unsigned long integer. The available codes are:
44	nigel	63	<pre>
45	ph10	691	PCRE_CONFIG_JIT Availability of just-in-time compiler
46			support (1=yes 0=no)
47	ph10	903	PCRE_CONFIG_JITTARGET String containing information about the
48			target architecture for the JIT compiler,
49			or NULL if there is no JIT support
50	nigel	73	PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
51			PCRE_CONFIG_MATCH_LIMIT Internal resource limit
52	nigel	87	PCRE_CONFIG_MATCH_LIMIT_RECURSION
53			Internal recursion depth limit
54	ph10	231	PCRE_CONFIG_NEWLINE Value of the default newline sequence:
55	nigel	93	13 (0x000d) for CR
56			10 (0x000a) for LF
57			3338 (0x0d0a) for CRLF
58	ph10	150	-2 for ANYCRLF
59	nigel	93	-1 for ANY
60	ph10	231	PCRE_CONFIG_BSR Indicates what \R matches by default:
61			0 all Unicode line endings
62			1 CR, LF, or CRLF only
63	nigel	63	PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
64	ph10	691	Threshold of return slots, above which
65			<b>malloc()</b> is used by the POSIX API
66	nigel	73	PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
67	ph10	869	PCRE_CONFIG_UTF16 Availability of UTF-16 support (1=yes
68			0=no); option for <b>pcre16_config()</b>
69	ph10	1194	PCRE_CONFIG_UTF32 Availability of UTF-32 support (1=yes
70			0=no); option for <b>pcre32_config()</b>
71	ph10	869	PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no);
72			option for <b>pcre_config()</b>
73	nigel	75	PCRE_CONFIG_UNICODE_PROPERTIES
74			Availability of Unicode property support
75			(1=yes 0=no)
76			</pre>
77	ph10	903	The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
78	ph10	1194	is also given if PCRE_CONFIG_UTF16 or PCRE_CONFIG_UTF32 is passed to
79			<b>pcre_config()</b>, if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF32 is passed to
80			<b>pcre16_config()</b>, or if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF16 is passed to
81			<b>pcre32_config()</b>.
82	nigel	63	</P>
83			<P>
84			There is a complete description of the PCRE native API in the
85			<a href="pcreapi.html"><b>pcreapi</b></a>
86	nigel	75	page and a description of the POSIX API in the
87	nigel	63	<a href="pcreposix.html"><b>pcreposix</b></a>
88			page.
89	nigel	75	<p>
90			Return to the <a href="index.html">PCRE index page</a>.
91			</p>
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"