Annotation of embedaddon/pcre/doc/html/pcre_config.html, revision 1.1.1.2

1.1       misho       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>
1.1.1.2 ! misho      24: <P>
        !            25: <b>int pcre16_config(int <i>what</i>, void *<i>where</i>);</b>
        !            26: </P>
1.1       misho      27: <br><b>
                     28: DESCRIPTION
                     29: </b><br>
                     30: <P>
                     31: This function makes it possible for a client program to find out which optional
                     32: features are available in the version of the PCRE library it is using. The
                     33: arguments are as follows:
                     34: <pre>
                     35:   <i>what</i>     A code specifying what information is required
                     36:   <i>where</i>    Points to where to put the data
                     37: </pre>
                     38: The <i>where</i> argument must point to an integer variable, except for
                     39: PCRE_CONFIG_MATCH_LIMIT and PCRE_CONFIG_MATCH_LIMIT_RECURSION, when it must
                     40: point to an unsigned long integer. The available codes are:
                     41: <pre>
                     42:   PCRE_CONFIG_JIT           Availability of just-in-time compiler
                     43:                               support (1=yes 0=no)
1.1.1.2 ! misho      44:   PCRE_CONFIG_JITTARGET     String containing information about the
        !            45:                               target architecture for the JIT compiler,
        !            46:                               or NULL if there is no JIT support
1.1       misho      47:   PCRE_CONFIG_LINK_SIZE     Internal link size: 2, 3, or 4
                     48:   PCRE_CONFIG_MATCH_LIMIT   Internal resource limit
                     49:   PCRE_CONFIG_MATCH_LIMIT_RECURSION
                     50:                             Internal recursion depth limit
                     51:   PCRE_CONFIG_NEWLINE       Value of the default newline sequence:
                     52:                                 13 (0x000d)    for CR
                     53:                                 10 (0x000a)    for LF
                     54:                               3338 (0x0d0a)    for CRLF
                     55:                                 -2             for ANYCRLF
                     56:                                 -1             for ANY
                     57:   PCRE_CONFIG_BSR           Indicates what \R matches by default:
                     58:                                  0             all Unicode line endings
                     59:                                  1             CR, LF, or CRLF only
                     60:   PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
                     61:                             Threshold of return slots, above which
                     62:                               <b>malloc()</b> is used by the POSIX API
                     63:   PCRE_CONFIG_STACKRECURSE  Recursion implementation (1=stack 0=heap)
1.1.1.2 ! misho      64:   PCRE_CONFIG_UTF16         Availability of UTF-16 support (1=yes
        !            65:                                0=no); option for <b>pcre16_config()</b>
        !            66:   PCRE_CONFIG_UTF8          Availability of UTF-8 support (1=yes 0=no);
        !            67:                               option for <b>pcre_config()</b>
1.1       misho      68:   PCRE_CONFIG_UNICODE_PROPERTIES
                     69:                             Availability of Unicode property support
                     70:                               (1=yes 0=no)
                     71: </pre>
1.1.1.2 ! misho      72: The function yields 0 on success or PCRE_ERROR_BADOPTION otherwise. That error
        !            73: is also given if PCRE_CONFIG_UTF16 is passed to <b>pcre_config()</b> or if
        !            74: PCRE_CONFIG_UTF8 is passed to <b>pcre16_config()</b>.
1.1       misho      75: </P>
                     76: <P>
                     77: There is a complete description of the PCRE native API in the
                     78: <a href="pcreapi.html"><b>pcreapi</b></a>
                     79: page and a description of the POSIX API in the
                     80: <a href="pcreposix.html"><b>pcreposix</b></a>
                     81: page.
                     82: <p>
                     83: Return to the <a href="index.html">PCRE index page</a>.
                     84: </p>

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>