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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 79 - (show annotations) (download)
Sat Feb 24 21:40:52 2007 UTC (7 years, 8 months ago) by nigel
File size: 2315 byte(s)
Load pcre-6.1 into code/trunk.

1 .TH PCRE_COMPILE2 3
2 .SH NAME
3 PCRE - Perl-compatible regular expressions
4 .SH SYNOPSIS
5 .rs
6 .sp
7 .B #include <pcre.h>
8 .PP
9 .SM
10 .br
11 .B pcre *pcre_compile2(const char *\fIpattern\fP, int \fIoptions\fP,
12 .ti +5n
13 .B int *\fIerrorcodeptr\fP,
14 .ti +5n
15 .B const char **\fIerrptr\fP, int *\fIerroffset\fP,
16 .ti +5n
17 .B const unsigned char *\fItableptr\fP);
18 .
19 .SH DESCRIPTION
20 .rs
21 .sp
22 This function compiles a regular expression into an internal form. It is the
23 same as \fBpcre_compile()\fP, except for the addition of the \fIerrorcodeptr\fP
24 argument. The arguments are:
25
26 .sp
27 \fIpattern\fR A zero-terminated string containing the
28 regular expression to be compiled
29 \fIoptions\fR Zero or more option bits
30 \fIerrorcodeptr\fP Where to put an error code
31 \fIerrptr\fR Where to put an error message
32 \fIerroffset\fR Offset in pattern where error was found
33 \fItableptr\fR Pointer to character tables, or NULL to
34 use the built-in default
35 .sp
36 The option bits are:
37 .sp
38 PCRE_ANCHORED Force pattern anchoring
39 PCRE_AUTO_CALLOUT Compile automatic callouts
40 PCRE_CASELESS Do caseless matching
41 PCRE_DOLLAR_ENDONLY $ not to match newline at end
42 PCRE_DOTALL . matches anything including NL
43 PCRE_EXTENDED Ignore whitespace and # comments
44 PCRE_EXTRA PCRE extra features
45 (not much use currently)
46 PCRE_FIRSTLINE Force matching to be before newline
47 PCRE_MULTILINE ^ and $ match newlines within data
48 PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren-
49 theses (named ones available)
50 PCRE_UNGREEDY Invert greediness of quantifiers
51 PCRE_UTF8 Run in UTF-8 mode
52 PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8
53 validity (only relevant if
54 PCRE_UTF8 is set)
55 .sp
56 PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
57 PCRE_NO_UTF8_CHECK.
58 .P
59 The yield of the function is a pointer to a private data structure that
60 contains the compiled pattern, or NULL if an error was detected.
61 .P
62 There is a complete description of the PCRE native API in the
63 .\" HREF
64 \fBpcreapi\fR
65 .\"
66 page and a description of the POSIX API in the
67 .\" HREF
68 \fBpcreposix\fR
69 .\"
70 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12