/[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 71 by nigel, Sat Feb 24 21:40:24 2007 UTC revision 77 by nigel, Sat Feb 24 21:40:45 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 23  DESCRIPTION Line 29  DESCRIPTION
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. Its
31  arguments are:  arguments are:
 </P>  
 <P>  
32  <pre>  <pre>
33    <i>pattern</i>       A zero-terminated string containing the    <i>pattern</i>       A zero-terminated string containing the
34                    regular expression to be compiled                    regular expression to be compiled
# Line 33  arguments are: Line 37  arguments are:
37    <i>erroffset</i>     Offset in pattern where error was found    <i>erroffset</i>     Offset in pattern where error was found
38    <i>tableptr</i>      Pointer to character tables, or NULL to    <i>tableptr</i>      Pointer to character tables, or NULL to
39                    use the built-in default                    use the built-in default
40  </PRE>  </pre>
 </P>  
 <P>  
41  The option bits are:  The option bits are:
 </P>  
 <P>  
42  <pre>  <pre>
43    PCRE_ANCHORED         Force pattern anchoring    PCRE_ANCHORED         Force pattern anchoring
44      PCRE_AUTO_CALLOUT     Compile automatic callouts
45    PCRE_CASELESS         Do caseless matching    PCRE_CASELESS         Do caseless matching
46    PCRE_DOLLAR_ENDONLY   $ not to match newline at end    PCRE_DOLLAR_ENDONLY   $ not to match newline at end
47    PCRE_DOTALL           . matches anything including NL    PCRE_DOTALL           . matches anything including NL
48    PCRE_EXTENDED         Ignore whitespace and # comments    PCRE_EXTENDED         Ignore whitespace and # comments
49    PCRE_EXTRA            PCRE extra features    PCRE_EXTRA            PCRE extra features
50                            (not much use currently)                            (not much use currently)
51      PCRE_FIRSTLINE        Force matching to be before newline
52    PCRE_MULTILINE        ^ and $ match newlines within data    PCRE_MULTILINE        ^ and $ match newlines within data
53    PCRE_NO_AUTO_CAPTURE  Disable numbered capturing paren-    PCRE_NO_AUTO_CAPTURE  Disable numbered capturing paren-
54                            theses (named ones available)                            theses (named ones available)
# Line 55  The option bits are: Line 57  The option bits are:
57    PCRE_NO_UTF8_CHECK    Do not check the pattern for UTF-8    PCRE_NO_UTF8_CHECK    Do not check the pattern for UTF-8
58                            validity (only relevant if                            validity (only relevant if
59                            PCRE_UTF8 is set)                            PCRE_UTF8 is set)
60  </PRE>  </pre>
61  </P>  PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
62  <P>  PCRE_NO_UTF8_CHECK.
 PCRE must be compiled with UTF-8 support in order to use PCRE_UTF8  
 (or PCRE_NO_UTF8_CHECK).  
63  </P>  </P>
64  <P>  <P>
65  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
66  contains the compiled pattern, or NULL if an error was detected.  contains the compiled pattern, or NULL if an error was detected.
67  </P>  </P>
68  <P>  <P>
69  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
70  <a href="pcreapi.html"><b>pcreapi</b></a>  <a href="pcreapi.html"><b>pcreapi</b></a>
71    page and a description of the POSIX API in the
72    <a href="pcreposix.html"><b>pcreposix</b></a>
73  page.  page.
74    <p>
75    Return to the <a href="index.html">PCRE index page</a>.
76    </p>

Legend:
Removed from v.71  
changed lines
  Added in v.77

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12