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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 77 - (show annotations) (download) (as text)
Sat Feb 24 21:40:45 2007 UTC (7 years, 8 months ago) by nigel
File MIME type: text/html
File size: 2672 byte(s)
Load pcre-6.0 into code/trunk.

1 <html>
2 <head>
3 <title>pcre_compile specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre_compile 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_compile(const char *<i>pattern</i>, int <i>options</i>,</b>
23 <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
24 <b>const unsigned char *<i>tableptr</i>);</b>
25 </P>
26 <br><b>
27 DESCRIPTION
28 </b><br>
29 <P>
30 This function compiles a regular expression into an internal form. Its
31 arguments are:
32 <pre>
33 <i>pattern</i> A zero-terminated string containing the
34 regular expression to be compiled
35 <i>options</i> Zero or more option bits
36 <i>errptr</i> Where to put an error message
37 <i>erroffset</i> Offset in pattern where error was found
38 <i>tableptr</i> Pointer to character tables, or NULL to
39 use the built-in default
40 </pre>
41 The option bits are:
42 <pre>
43 PCRE_ANCHORED Force pattern anchoring
44 PCRE_AUTO_CALLOUT Compile automatic callouts
45 PCRE_CASELESS Do caseless matching
46 PCRE_DOLLAR_ENDONLY $ not to match newline at end
47 PCRE_DOTALL . matches anything including NL
48 PCRE_EXTENDED Ignore whitespace and # comments
49 PCRE_EXTRA PCRE extra features
50 (not much use currently)
51 PCRE_FIRSTLINE Force matching to be before newline
52 PCRE_MULTILINE ^ and $ match newlines within data
53 PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren-
54 theses (named ones available)
55 PCRE_UNGREEDY Invert greediness of quantifiers
56 PCRE_UTF8 Run in UTF-8 mode
57 PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8
58 validity (only relevant if
59 PCRE_UTF8 is set)
60 </pre>
61 PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
62 PCRE_NO_UTF8_CHECK.
63 </P>
64 <P>
65 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.
67 </P>
68 <P>
69 There is a complete description of the PCRE native API in the
70 <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.
74 <p>
75 Return to the <a href="index.html">PCRE index page</a>.
76 </p>

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12