blob: a18a2e0868cc0c101262eb198821b40f3fc4bf45 [file] [log] [blame]
Tristan Matthews04616462013-11-14 16:09:34 -05001<html>
2<head>
3<title>pcre_config specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre_config man page</h1>
7<p>
8Return to the <a href="index.html">PCRE index page</a>.
9</p>
10<p>
11This page is part of the PCRE HTML documentation. It was generated automatically
12from the original man page. If there is any nonsense in it, please consult the
13man page, in case the conversion went wrong.
14<br>
15<br><b>
16SYNOPSIS
17</b><br>
18<P>
19<b>#include &#60;pcre.h&#62;</b>
20</P>
21<P>
22<b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
23</P>
24<br><b>
25DESCRIPTION
26</b><br>
27<P>
28This function makes it possible for a client program to find out which optional
29features are available in the version of the PCRE library it is using. The
30arguments are as follows:
31<pre>
32 <i>what</i> A code specifying what information is required
33 <i>where</i> Points to where to put the data
34</pre>
35The <i>where</i> argument must point to an integer variable, except for
36PCRE_CONFIG_MATCH_LIMIT and PCRE_CONFIG_MATCH_LIMIT_RECURSION, when it must
37point to an unsigned long integer. The available codes are:
38<pre>
39 PCRE_CONFIG_JIT Availability of just-in-time compiler
40 support (1=yes 0=no)
41 PCRE_CONFIG_LINK_SIZE Internal link size: 2, 3, or 4
42 PCRE_CONFIG_MATCH_LIMIT Internal resource limit
43 PCRE_CONFIG_MATCH_LIMIT_RECURSION
44 Internal recursion depth limit
45 PCRE_CONFIG_NEWLINE Value of the default newline sequence:
46 13 (0x000d) for CR
47 10 (0x000a) for LF
48 3338 (0x0d0a) for CRLF
49 -2 for ANYCRLF
50 -1 for ANY
51 PCRE_CONFIG_BSR Indicates what \R matches by default:
52 0 all Unicode line endings
53 1 CR, LF, or CRLF only
54 PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
55 Threshold of return slots, above which
56 <b>malloc()</b> is used by the POSIX API
57 PCRE_CONFIG_STACKRECURSE Recursion implementation (1=stack 0=heap)
58 PCRE_CONFIG_UTF8 Availability of UTF-8 support (1=yes 0=no)
59 PCRE_CONFIG_UNICODE_PROPERTIES
60 Availability of Unicode property support
61 (1=yes 0=no)
62</pre>
63The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise.
64</P>
65<P>
66There is a complete description of the PCRE native API in the
67<a href="pcreapi.html"><b>pcreapi</b></a>
68page and a description of the POSIX API in the
69<a href="pcreposix.html"><b>pcreposix</b></a>
70page.
71<p>
72Return to the <a href="index.html">PCRE index page</a>.
73</p>