1 .TH PCRE2_CONFIG 3 "16 September 2017" "PCRE2 10.31"
3 PCRE2 - Perl-compatible regular expressions (revised API)
10 .B int pcre2_config(uint32_t \fIwhat\fP, void *\fIwhere\fP);
15 This function makes it possible for a client program to find out which optional
16 features are available in the version of the PCRE2 library it is using. The
17 arguments are as follows:
19 \fIwhat\fP A code specifying what information is required
20 \fIwhere\fP Points to where to put the information
22 If \fIwhere\fP is NULL, the function returns the amount of memory needed for
23 the requested information. When the information is a string, the value is in
24 code units; for other types of data it is in bytes.
26 If \fBwhere\fP is not NULL, for PCRE2_CONFIG_JITTARGET,
27 PCRE2_CONFIG_UNICODE_VERSION, and PCRE2_CONFIG_VERSION it must point to a
28 buffer that is large enough to hold the string. For all other codes it must
29 point to a uint32_t integer variable. The available codes are:
31 PCRE2_CONFIG_BSR Indicates what \eR matches by default:
34 PCRE2_CONFIG_COMPILED_WIDTHS Which of 8/16/32 support was compiled
35 PCRE2_CONFIG_DEPTHLIMIT Default backtracking depth limit
36 PCRE2_CONFIG_HEAPLIMIT Default heap memory limit
38 PCRE2_CONFIG_JIT Availability of just-in-time compiler
41 PCRE2_CONFIG_JITTARGET Information (a string) about the target
42 architecture for the JIT compiler
43 PCRE2_CONFIG_LINKSIZE Configured internal link size (2, 3, 4)
44 PCRE2_CONFIG_MATCHLIMIT Default internal resource limit
45 PCRE2_CONFIG_NEVER_BACKSLASH_C Whether or not \eC is disabled
46 PCRE2_CONFIG_NEWLINE Code for the default newline sequence:
53 PCRE2_CONFIG_PARENSLIMIT Default parentheses nesting limit
54 PCRE2_CONFIG_RECURSIONLIMIT Obsolete: use PCRE2_CONFIG_DEPTHLIMIT
55 PCRE2_CONFIG_STACKRECURSE Obsolete: always returns 0
57 PCRE2_CONFIG_UNICODE Availability of Unicode support (1=yes
59 PCRE2_CONFIG_UNICODE_VERSION The Unicode version (a string)
60 PCRE2_CONFIG_VERSION The PCRE2 version (a string)
62 The function yields a non-negative value on success or the negative value
63 PCRE2_ERROR_BADOPTION otherwise. This is also the result for the
64 PCRE2_CONFIG_JITTARGET code if JIT support is not available. When a string is
65 requested, the function returns the number of code units used, including the
68 There is a complete description of the PCRE2 native API in the
72 page and a description of the POSIX API in the