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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 93 - (show annotations) (download) (as text)
Sat Feb 24 21:41:42 2007 UTC (7 years, 9 months ago) by nigel
File MIME type: text/html
File size: 3161 byte(s)
Load pcre-7.0 into code/trunk.

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 </P>
35 <P>
36 <pre>
37 <i>pattern</i> A zero-terminated string containing the
38 regular expression to be compiled
39 <i>options</i> Zero or more option bits
40 <i>errorcodeptr</i> Where to put an error code
41 <i>errptr</i> Where to put an error message
42 <i>erroffset</i> Offset in pattern where error was found
43 <i>tableptr</i> Pointer to character tables, or NULL to
44 use the built-in default
45 </pre>
46 The option bits are:
47 <pre>
48 PCRE_ANCHORED Force pattern anchoring
49 PCRE_AUTO_CALLOUT Compile automatic callouts
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_MULTILINE ^ and $ match newlines within data
59 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
60 PCRE_NEWLINE_CR Set CR as the newline sequence
61 PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
62 PCRE_NEWLINE_LF Set LF as the newline sequence
63 PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren-
64 theses (named ones available)
65 PCRE_UNGREEDY Invert greediness of quantifiers
66 PCRE_UTF8 Run in UTF-8 mode
67 PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8
68 validity (only relevant if
69 PCRE_UTF8 is set)
70 </pre>
71 PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
72 PCRE_NO_UTF8_CHECK.
73 </P>
74 <P>
75 The yield of the function is a pointer to a private data structure that
76 contains the compiled pattern, or NULL if an error was detected.
77 </P>
78 <P>
79 There is a complete description of the PCRE native API in the
80 <a href="pcreapi.html"><b>pcreapi</b></a>
81 page and a description of the POSIX API in the
82 <a href="pcreposix.html"><b>pcreposix</b></a>
83 page.
84 <p>
85 Return to the <a href="index.html">PCRE index page</a>.
86 </p>

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12