1PCRE2_CONFIG(3)            Library Functions Manual            PCRE2_CONFIG(3)
2
3
4

NAME

6       PCRE2 - Perl-compatible regular expressions (revised API)
7

SYNOPSIS

9
10       #include <pcre2.h>
11
12       int pcre2_config(uint32_t what, void *where);
13

DESCRIPTION

15
16       This  function makes it possible for a client program to find out which
17       optional features are available in the version of the PCRE2 library  it
18       is using. The arguments are as follows:
19
20         what     A code specifying what information is required
21         where    Points to where to put the information
22
23       If  where is NULL, the function returns the amount of memory needed for
24       the requested information. When the information is a string, the  value
25       is in code units; for other types of data it is in bytes.
26
27       If  where  is  not  NULL, for PCRE2_CONFIG_JITTARGET, PCRE2_CONFIG_UNI‐
28       CODE_VERSION, and PCRE2_CONFIG_VERSION it must point to a  buffer  that
29       is  large  enough to hold the string. For all other codes it must point
30       to a uint32_t integer variable. The available codes are:
31
32         PCRE2_CONFIG_BSR             Indicates what \R matches by default:
33                                        PCRE2_BSR_UNICODE
34                                        PCRE2_BSR_ANYCRLF
35         PCRE2_CONFIG_COMPILED_WIDTHS Which of 8/16/32 support was compiled
36         PCRE2_CONFIG_DEPTHLIMIT      Default backtracking depth limit
37         PCRE2_CONFIG_HEAPLIMIT       Default heap memory limit
38         PCRE2_CONFIG_JIT             Availability of just-in-time compiler
39                                       support (1=yes 0=no)
40         PCRE2_CONFIG_JITTARGET       Information (a string) about the target
41                                        architecture for the JIT compiler
42         PCRE2_CONFIG_LINKSIZE        Configured internal link size (2, 3, 4)
43         PCRE2_CONFIG_MATCHLIMIT      Default internal resource limit
44         PCRE2_CONFIG_NEVER_BACKSLASH_C  Whether or not \C is disabled
45         PCRE2_CONFIG_NEWLINE         Code for the default newline sequence:
46                                        PCRE2_NEWLINE_CR
47                                        PCRE2_NEWLINE_LF
48                                        PCRE2_NEWLINE_CRLF
49                                        PCRE2_NEWLINE_ANY
50                                        PCRE2_NEWLINE_ANYCRLF
51                                        PCRE2_NEWLINE_NUL
52         PCRE2_CONFIG_PARENSLIMIT     Default parentheses nesting limit
53         PCRE2_CONFIG_RECURSIONLIMIT  Obsolete: use PCRE2_CONFIG_DEPTHLIMIT
54         PCRE2_CONFIG_STACKRECURSE    Obsolete: always returns 0
55         PCRE2_CONFIG_UNICODE         Availability of Unicode support (1=yes
56                                        0=no)
57         PCRE2_CONFIG_UNICODE_VERSION The Unicode version (a string)
58         PCRE2_CONFIG_VERSION         The PCRE2 version (a string)
59
60       The function yields a non-negative value on  success  or  the  negative
61       value  PCRE2_ERROR_BADOPTION otherwise. This is also the result for the
62       PCRE2_CONFIG_JITTARGET code if JIT support is  not  available.  When  a
63       string  is  requested,  the  function  returns the number of code units
64       used, including the terminating zero.
65
66       There is a complete description of the PCRE2 native API in the pcre2api
67       page and a description of the POSIX API in the pcre2posix page.
68
69
70
71PCRE2 10.31                    16 September 2017               PCRE2_CONFIG(3)
Impressum