Annotation of embedaddon/pcre/doc/html/pcre_compile2.html, revision 1.1

1.1     ! misho       1: <html>
        !             2: <head>
        !             3: <title>pcre_compile2 specification</title>
        !             4: </head>
        !             5: <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
        !             6: <h1>pcre_compile2 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>pcre *pcre_compile2(const char *<i>pattern</i>, int <i>options</i>,</b>
        !            23: <b>int *<i>errorcodeptr</i>,</b>
        !            24: <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
        !            25: <b>const unsigned char *<i>tableptr</i>);</b>
        !            26: </P>
        !            27: <br><b>
        !            28: DESCRIPTION
        !            29: </b><br>
        !            30: <P>
        !            31: This function compiles a regular expression into an internal form. It is the
        !            32: same as <b>pcre_compile()</b>, except for the addition of the <i>errorcodeptr</i>
        !            33: argument. The arguments are:
        !            34: <pre>
        !            35:   <i>pattern</i>       A zero-terminated string containing the
        !            36:                   regular expression to be compiled
        !            37:   <i>options</i>       Zero or more option bits
        !            38:   <i>errorcodeptr</i>  Where to put an error code
        !            39:   <i>errptr</i>        Where to put an error message
        !            40:   <i>erroffset</i>     Offset in pattern where error was found
        !            41:   <i>tableptr</i>      Pointer to character tables, or NULL to
        !            42:                   use the built-in default
        !            43: </pre>
        !            44: The option bits are:
        !            45: <pre>
        !            46:   PCRE_ANCHORED           Force pattern anchoring
        !            47:   PCRE_AUTO_CALLOUT       Compile automatic callouts
        !            48:   PCRE_BSR_ANYCRLF        \R matches only CR, LF, or CRLF
        !            49:   PCRE_BSR_UNICODE        \R matches all Unicode line endings
        !            50:   PCRE_CASELESS           Do caseless matching
        !            51:   PCRE_DOLLAR_ENDONLY     $ not to match newline at end
        !            52:   PCRE_DOTALL             . matches anything including NL
        !            53:   PCRE_DUPNAMES           Allow duplicate names for subpatterns
        !            54:   PCRE_EXTENDED           Ignore whitespace and # comments
        !            55:   PCRE_EXTRA              PCRE extra features
        !            56:                             (not much use currently)
        !            57:   PCRE_FIRSTLINE          Force matching to be before newline
        !            58:   PCRE_JAVASCRIPT_COMPAT  JavaScript compatibility
        !            59:   PCRE_MULTILINE          ^ and $ match newlines within data
        !            60:   PCRE_NEWLINE_ANY        Recognize any Unicode newline sequence
        !            61:   PCRE_NEWLINE_ANYCRLF    Recognize CR, LF, and CRLF as newline
        !            62:                             sequences
        !            63:   PCRE_NEWLINE_CR         Set CR as the newline sequence
        !            64:   PCRE_NEWLINE_CRLF       Set CRLF as the newline sequence
        !            65:   PCRE_NEWLINE_LF         Set LF as the newline sequence
        !            66:   PCRE_NO_AUTO_CAPTURE    Disable numbered capturing paren-
        !            67:                             theses (named ones available)
        !            68:   PCRE_NO_UTF8_CHECK      Do not check the pattern for UTF-8
        !            69:                             validity (only relevant if
        !            70:                             PCRE_UTF8 is set)
        !            71:   PCRE_UCP                Use Unicode properties for \d, \w, etc.
        !            72:   PCRE_UNGREEDY           Invert greediness of quantifiers
        !            73:   PCRE_UTF8               Run in UTF-8 mode
        !            74: </pre>
        !            75: PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
        !            76: PCRE_NO_UTF8_CHECK, and with UCP support if PCRE_UCP is used.
        !            77: </P>
        !            78: <P>
        !            79: The yield of the function is a pointer to a private data structure that
        !            80: contains the compiled pattern, or NULL if an error was detected. Note that
        !            81: compiling regular expressions with one version of PCRE for use with a different
        !            82: version is not guaranteed to work and may cause crashes.
        !            83: </P>
        !            84: <P>
        !            85: There is a complete description of the PCRE native API in the
        !            86: <a href="pcreapi.html"><b>pcreapi</b></a>
        !            87: page and a description of the POSIX API in the
        !            88: <a href="pcreposix.html"><b>pcreposix</b></a>
        !            89: page.
        !            90: <p>
        !            91: Return to the <a href="index.html">PCRE index page</a>.
        !            92: </p>

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