1 <html> 2 <head> 3 <title>pcre2_config specification</title> 4 </head> 5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6 <h1>pcre2_config man page</h1> 7 <p> 8 Return to the <a href="index.html">PCRE2 index page</a>. 9 </p> 10 <p> 11 This page is part of the PCRE2 HTML documentation. It was generated 12 automatically from the original man page. If there is any nonsense in it, 13 please consult the man page, in case the conversion went wrong. 14 <br> 15 <br><b> 16 SYNOPSIS 17 </b><br> 18 <P> 19 <b>#include <pcre2.h></b> 20 </P> 21 <P> 22 <b>int pcre2_config(uint32_t <i>what</i>, void *<i>where</i>);</b> 23 </P> 24 <br><b> 25 DESCRIPTION 26 </b><br> 27 <P> 28 This function makes it possible for a client program to find out which optional 29 features are available in the version of the PCRE2 library it is using. The 30 arguments 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 information 34 </pre> 35 If <i>where</i> is NULL, the function returns the amount of memory needed for 36 the requested information. When the information is a string, the value is in 37 code units; for other types of data it is in bytes. 38 </P> 39 <P> 40 If <b>where</b> is not NULL, for PCRE2_CONFIG_JITTARGET, 41 PCRE2_CONFIG_UNICODE_VERSION, and PCRE2_CONFIG_VERSION it must point to a 42 buffer that is large enough to hold the string. For all other codes it must 43 point to a uint32_t integer variable. The available codes are: 44 <pre> 45 PCRE2_CONFIG_BSR Indicates what \R matches by default: 46 PCRE2_BSR_UNICODE 47 PCRE2_BSR_ANYCRLF 48 PCRE2_CONFIG_COMPILED_WIDTHS Which of 8/16/32 support was compiled 49 PCRE2_CONFIG_DEPTHLIMIT Default backtracking depth limit 50 PCRE2_CONFIG_HEAPLIMIT Default heap memory limit 51 PCRE2_CONFIG_JIT Availability of just-in-time compiler support (1=yes 0=no) 52 PCRE2_CONFIG_JITTARGET Information (a string) about the target architecture for the JIT compiler 53 PCRE2_CONFIG_LINKSIZE Configured internal link size (2, 3, 4) 54 PCRE2_CONFIG_MATCHLIMIT Default internal resource limit 55 PCRE2_CONFIG_NEVER_BACKSLASH_C Whether or not \C is disabled 56 PCRE2_CONFIG_NEWLINE Code for the default newline sequence: 57 PCRE2_NEWLINE_CR 58 PCRE2_NEWLINE_LF 59 PCRE2_NEWLINE_CRLF 60 PCRE2_NEWLINE_ANY 61 PCRE2_NEWLINE_ANYCRLF 62 PCRE2_NEWLINE_NUL 63 PCRE2_CONFIG_PARENSLIMIT Default parentheses nesting limit 64 PCRE2_CONFIG_RECURSIONLIMIT Obsolete: use PCRE2_CONFIG_DEPTHLIMIT 65 PCRE2_CONFIG_STACKRECURSE Obsolete: always returns 0 66 PCRE2_CONFIG_UNICODE Availability of Unicode support (1=yes 0=no) 67 PCRE2_CONFIG_UNICODE_VERSION The Unicode version (a string) 68 PCRE2_CONFIG_VERSION The PCRE2 version (a string) 69 </pre> 70 The function yields a non-negative value on success or the negative value 71 PCRE2_ERROR_BADOPTION otherwise. This is also the result for the 72 PCRE2_CONFIG_JITTARGET code if JIT support is not available. When a string is 73 requested, the function returns the number of code units used, including the 74 terminating zero. 75 </P> 76 <P> 77 There is a complete description of the PCRE2 native API in the 78 <a href="pcre2api.html"><b>pcre2api</b></a> 79 page and a description of the POSIX API in the 80 <a href="pcre2posix.html"><b>pcre2posix</b></a> 81 page. 82 <p> 83 Return to the <a href="index.html">PCRE2 index page</a>. 84 </p> 85
