Home | History | Annotate | Download | only in html
      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 &#60;pcre2.h&#62;</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_JIT             Availability of just-in-time compiler
     49                                 support (1=yes 0=no)
     50   PCRE2_CONFIG_JITTARGET       Information about the target archi-
     51                                  tecture for the JIT compiler
     52   PCRE2_CONFIG_LINKSIZE        Configured internal link size (2, 3, 4)
     53   PCRE2_CONFIG_MATCHLIMIT      Default internal resource limit
     54   PCRE2_CONFIG_NEWLINE         Code for the default newline sequence:
     55                                  PCRE2_NEWLINE_CR
     56                                  PCRE2_NEWLINE_LF
     57                                  PCRE2_NEWLINE_CRLF
     58                                  PCRE2_NEWLINE_ANY
     59                                  PCRE2_NEWLINE_ANYCRLF
     60   PCRE2_CONFIG_PARENSLIMIT     Default parentheses nesting limit
     61   PCRE2_CONFIG_RECURSIONLIMIT  Internal recursion depth limit
     62   PCRE2_CONFIG_STACKRECURSE    Recursion implementation (1=stack
     63                                  0=heap)
     64   PCRE2_CONFIG_UNICODE         Availability of Unicode support (1=yes
     65                                  0=no)
     66   PCRE2_CONFIG_UNICODE_VERSION The Unicode version (a string)
     67   PCRE2_CONFIG_VERSION         The PCRE2 version (a string)
     68 </pre>
     69 The function yields a non-negative value on success or the negative value
     70 PCRE2_ERROR_BADOPTION otherwise. This is also the result for the
     71 PCRE2_CONFIG_JITTARGET code if JIT support is not available. When a string is
     72 requested, the function returns the number of code units used, including the
     73 terminating zero.
     74 </P>
     75 <P>
     76 There is a complete description of the PCRE2 native API in the
     77 <a href="pcre2api.html"><b>pcre2api</b></a>
     78 page and a description of the POSIX API in the
     79 <a href="pcre2posix.html"><b>pcre2posix</b></a>
     80 page.
     81 <p>
     82 Return to the <a href="index.html">PCRE2 index page</a>.
     83 </p>
     84