/[pcre]/code/trunk/doc/html/pcre_compile.html
ViewVC logotype

Diff of /code/trunk/doc/html/pcre_compile.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 63 by nigel, Sat Feb 24 21:40:03 2007 UTC revision 231 by ph10, Tue Sep 11 11:15:33 2007 UTC
# Line 3  Line 3 
3  <title>pcre_compile specification</title>  <title>pcre_compile specification</title>
4  </head>  </head>
5  <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">  <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6  This HTML document has been generated automatically from the original man page.  <h1>pcre_compile man page</h1>
7  If there is any nonsense in it, please consult the man page, in case the  <p>
8  conversion went wrong.<br>  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>  <br><b>
16  SYNOPSIS  SYNOPSIS
17  </b><br>  </b><br>
# Line 21  SYNOPSIS Line 27  SYNOPSIS
27  DESCRIPTION  DESCRIPTION
28  </b><br>  </b><br>
29  <P>  <P>
30  This function compiles a regular expression into an internal form. Its  This function compiles a regular expression into an internal form. It is the
31  arguments are:  same as <b>pcre_compile2()</b>, except for the absence of the <i>errorcodeptr</i>
32  </P>  argument. Its arguments are:
 <P>  
33  <pre>  <pre>
34    <i>pattern</i>       A zero-terminated string containing the    <i>pattern</i>       A zero-terminated string containing the
35                    regular expression to be compiled                    regular expression to be compiled
# Line 33  arguments are: Line 38  arguments are:
38    <i>erroffset</i>     Offset in pattern where error was found    <i>erroffset</i>     Offset in pattern where error was found
39    <i>tableptr</i>      Pointer to character tables, or NULL to    <i>tableptr</i>      Pointer to character tables, or NULL to
40                    use the built-in default                    use the built-in default
41  </PRE>  </pre>
 </P>  
 <P>  
42  The option bits are:  The option bits are:
 </P>  
 <P>  
43  <pre>  <pre>
44    PCRE_ANCHORED         Force pattern anchoring    PCRE_ANCHORED         Force pattern anchoring
45      PCRE_AUTO_CALLOUT     Compile automatic callouts
46      PCRE_BSR_ANYCRLF      \R matches only CR, LF, or CRLF
47      PCRE_BSR_UNICODE      \R matches all Unicode line endings
48    PCRE_CASELESS         Do caseless matching    PCRE_CASELESS         Do caseless matching
49    PCRE_DOLLAR_ENDONLY   $ not to match newline at end    PCRE_DOLLAR_ENDONLY   $ not to match newline at end
50    PCRE_DOTALL           . matches anything including NL    PCRE_DOTALL           . matches anything including NL
51      PCRE_DUPNAMES         Allow duplicate names for subpatterns
52    PCRE_EXTENDED         Ignore whitespace and # comments    PCRE_EXTENDED         Ignore whitespace and # comments
53    PCRE_EXTRA            PCRE extra features    PCRE_EXTRA            PCRE extra features
54                            (not much use currently)                            (not much use currently)
55      PCRE_FIRSTLINE        Force matching to be before newline
56    PCRE_MULTILINE        ^ and $ match newlines within data    PCRE_MULTILINE        ^ and $ match newlines within data
57      PCRE_NEWLINE_ANY      Recognize any Unicode newline sequence
58      PCRE_NEWLINE_ANYCRLF  Recognize CR, LF, and CRLF as newline sequences
59      PCRE_NEWLINE_CR       Set CR as the newline sequence
60      PCRE_NEWLINE_CRLF     Set CRLF as the newline sequence
61      PCRE_NEWLINE_LF       Set LF as the newline sequence
62    PCRE_NO_AUTO_CAPTURE  Disable numbered capturing paren-    PCRE_NO_AUTO_CAPTURE  Disable numbered capturing paren-
63                            theses (named ones available)                            theses (named ones available)
64    PCRE_UNGREEDY         Invert greediness of quantifiers    PCRE_UNGREEDY         Invert greediness of quantifiers
65    PCRE_UTF8             Run in UTF-8 mode    PCRE_UTF8             Run in UTF-8 mode
66  </PRE>    PCRE_NO_UTF8_CHECK    Do not check the pattern for UTF-8
67  </P>                            validity (only relevant if
68  <P>                            PCRE_UTF8 is set)
69  PCRE must have been compiled with UTF-8 support when PCRE_UTF8 is used.  </pre>
70    PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
71    PCRE_NO_UTF8_CHECK.
72  </P>  </P>
73  <P>  <P>
74  The yield of the function is a pointer to a private data structure that  The yield of the function is a pointer to a private data structure that
75  contains the compiled pattern, or NULL if an error was detected.  contains the compiled pattern, or NULL if an error was detected. Note that
76    compiling regular expressions with one version of PCRE for use with a different
77    version is not guaranteed to work and may cause crashes.
78  </P>  </P>
79  <P>  <P>
80  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
81  <a href="pcreapi.html"><b>pcreapi</b></a>  <a href="pcreapi.html"><b>pcreapi</b></a>
82    page and a description of the POSIX API in the
83    <a href="pcreposix.html"><b>pcreposix</b></a>
84  page.  page.
85    <p>
86    Return to the <a href="index.html">PCRE index page</a>.
87    </p>
Legend:
Removed from v.63  
changed lines
  Added in v.231
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12