Home | History | Annotate | Download | only in html
      1 <html>
      2 <head>
      3 <title>pcre_config specification</title>
      4 </head>
      5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
      6 <h1>pcre_config man page</h1>
      7 <p>
      8 Return to the <a href="index.html">PCRE index page</a>.
      9 </p>
     10 <p>
     11 This page is part of the PCRE HTML documentation. It was generated automatically
     12 from the original man page. If there is any nonsense in it, please consult the
     13 man page, in case the conversion went wrong.
     14 <br>
     15 <br><b>
     16 SYNOPSIS
     17 </b><br>
     18 <P>
     19 <b>#include &#60;pcre.h&#62;</b>
     20 </P>
     21 <P>
     22 <b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
     23 </P>
     24 <P>
     25 <b>int pcre16_config(int <i>what</i>, void *<i>where</i>);</b>
     26 </P>
     27 <P>
     28 <b>int pcre32_config(int <i>what</i>, void *<i>where</i>);</b>
     29 </P>
     30 <br><b>
     31 DESCRIPTION
     32 </b><br>
     33 <P>
     34 This function makes it possible for a client program to find out which optional
     35 features are available in the version of the PCRE library it is using. The
     36 arguments are as follows:
     37 <pre>
     38   <i>what</i>     A code specifying what information is required
     39   <i>where</i>    Points to where to put the data
     40 </pre>
     41 The <i>where</i> argument must point to an integer variable, except for
     42 PCRE_CONFIG_MATCH_LIMIT, PCRE_CONFIG_MATCH_LIMIT_RECURSION, and
     43 PCRE_CONFIG_PARENS_LIMIT, when it must point to an unsigned long integer,
     44 and for PCRE_CONFIG_JITTARGET, when it must point to a const char*.
     45 The available codes are:
     46 <pre>
     47   PCRE_CONFIG_JIT           Availability of just-in-time compiler
     48                               support (1=yes 0=no)
     49   PCRE_CONFIG_JITTARGET     String containing information about the
     50                               target architecture for the JIT compiler,
     51                               or NULL if there is no JIT support
     52   PCRE_CONFIG_LINK_SIZE     Internal link size: 2, 3, or 4
     53   PCRE_CONFIG_PARENS_LIMIT  Parentheses nesting limit
     54   PCRE_CONFIG_MATCH_LIMIT   Internal resource limit
     55   PCRE_CONFIG_MATCH_LIMIT_RECURSION
     56                             Internal recursion depth limit
     57   PCRE_CONFIG_NEWLINE       Value of the default newline sequence:
     58                                 13 (0x000d)    for CR
     59                                 10 (0x000a)    for LF
     60                               3338 (0x0d0a)    for CRLF
     61                                 -2             for ANYCRLF
     62                                 -1             for ANY
     63   PCRE_CONFIG_BSR           Indicates what \R matches by default:
     64                                  0             all Unicode line endings
     65                                  1             CR, LF, or CRLF only
     66   PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
     67                             Threshold of return slots, above which
     68                               <b>malloc()</b> is used by the POSIX API
     69   PCRE_CONFIG_STACKRECURSE  Recursion implementation (1=stack 0=heap)
     70   PCRE_CONFIG_UTF16         Availability of UTF-16 support (1=yes
     71                                0=no); option for <b>pcre16_config()</b>
     72   PCRE_CONFIG_UTF32         Availability of UTF-32 support (1=yes
     73                                0=no); option for <b>pcre32_config()</b>
     74   PCRE_CONFIG_UTF8          Availability of UTF-8 support (1=yes 0=no);
     75                               option for <b>pcre_config()</b>
     76   PCRE_CONFIG_UNICODE_PROPERTIES
     77                             Availability of Unicode property support
     78                               (1=yes 0=no)
     79 </pre>
     80 The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
     81 is also given if PCRE_CONFIG_UTF16 or PCRE_CONFIG_UTF32 is passed to
     82 <b>pcre_config()</b>, if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF32 is passed to
     83 <b>pcre16_config()</b>, or if PCRE_CONFIG_UTF8 or PCRE_CONFIG_UTF16 is passed to
     84 <b>pcre32_config()</b>.
     85 </P>
     86 <P>
     87 There is a complete description of the PCRE native API in the
     88 <a href="pcreapi.html"><b>pcreapi</b></a>
     89 page and a description of the POSIX API in the
     90 <a href="pcreposix.html"><b>pcreposix</b></a>
     91 page.
     92 <p>
     93 Return to the <a href="index.html">PCRE index page</a>.
     94 </p>
     95