aboutsummaryrefslogtreecommitdiffstats
path: root/external-libs/pcre/doc/pcre_config.3
blob: 3a0e6998b2b6769def0787d6acab6ac7f08c7090 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
.TH PCRE 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.br
.B int pcre_config(int \fIwhat\fR, void *\fIwhere\fR);

.SH DESCRIPTION
.rs
.sp
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. Its
arguments are as follows:

  \fIwhat\fR     A code specifying what information is required
  \fIwhere\fR    Points to where to put the data

The available codes are:

  PCRE_CONFIG_LINK_SIZE     Internal link size: 2, 3, or 4
  PCRE_CONFIG_MATCH_LIMIT   Internal resource limit
  PCRE_CONFIG_NEWLINE       Value of the newline character
  PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
                            Threshold of return slots, above
                              which \fBmalloc()\fR is used by
                              the POSIX API
  PCRE_CONFIG_STACKRECURSE  Recursion implementation (1=stack 0=heap)
  PCRE_CONFIG_UTF8          Availability of UTF-8 support (1=yes 0=no)

The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise.

There is a complete description of the PCRE native API in the
.\" HREF
\fBpcreapi\fR
.\"
page, and a description of the POSIX API in the
.\" HREF
\fBpcreposix\fR
.\"
page.