/[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 231 - (hide annotations) (download) (as text)
Tue Sep 11 11:15:33 2007 UTC (7 years ago) by ph10
File MIME type: text/html
File size: 3401 byte(s)
Add facility to make \R match only CR, LF, or CRLF.

1 nigel 63 <html>
2     <head>
3     <title>pcre_compile specification</title>
4     </head>
5     <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 nigel 75 <h1>pcre_compile man page</h1>
7     <p>
8     Return to the <a href="index.html">PCRE index page</a>.
9     </p>
10 ph10 111 <p>
11 nigel 75 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 ph10 111 <br>
15 nigel 63 <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 nigel 93 This function compiles a regular expression into an internal form. It is the
31     same as <b>pcre_compile2()</b>, except for the absence of the <i>errorcodeptr</i>
32     argument. Its arguments are:
33 nigel 63 <pre>
34     <i>pattern</i> A zero-terminated string containing the
35     regular expression to be compiled
36     <i>options</i> Zero or more option bits
37     <i>errptr</i> Where to put an error message
38     <i>erroffset</i> Offset in pattern where error was found
39     <i>tableptr</i> Pointer to character tables, or NULL to
40     use the built-in default
41 nigel 75 </pre>
42 nigel 63 The option bits are:
43     <pre>
44     PCRE_ANCHORED Force pattern anchoring
45 nigel 75 PCRE_AUTO_CALLOUT Compile automatic callouts
46 ph10 231 PCRE_BSR_ANYCRLF \R matches only CR, LF, or CRLF
47     PCRE_BSR_UNICODE \R matches all Unicode line endings
48 nigel 63 PCRE_CASELESS Do caseless matching
49     PCRE_DOLLAR_ENDONLY $ not to match newline at end
50     PCRE_DOTALL . matches anything including NL
51 nigel 91 PCRE_DUPNAMES Allow duplicate names for subpatterns
52 nigel 63 PCRE_EXTENDED Ignore whitespace and # comments
53     PCRE_EXTRA PCRE extra features
54     (not much use currently)
55 nigel 77 PCRE_FIRSTLINE Force matching to be before newline
56 nigel 63 PCRE_MULTILINE ^ and $ match newlines within data
57 nigel 93 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
58 ph10 150 PCRE_NEWLINE_ANYCRLF Recognize CR, LF, and CRLF as newline sequences
59 nigel 91 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 nigel 63 PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren-
63     theses (named ones available)
64     PCRE_UNGREEDY Invert greediness of quantifiers
65     PCRE_UTF8 Run in UTF-8 mode
66 nigel 71 PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8
67     validity (only relevant if
68     PCRE_UTF8 is set)
69 nigel 75 </pre>
70     PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and
71     PCRE_NO_UTF8_CHECK.
72 nigel 63 </P>
73     <P>
74     The yield of the function is a pointer to a private data structure that
75 ph10 155 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 nigel 63 </P>
79     <P>
80 nigel 75 There is a complete description of the PCRE native API in the
81 nigel 63 <a href="pcreapi.html"><b>pcreapi</b></a>
82 nigel 75 page and a description of the POSIX API in the
83     <a href="pcreposix.html"><b>pcreposix</b></a>
84 nigel 63 page.
85 nigel 75 <p>
86     Return to the <a href="index.html">PCRE index page</a>.
87     </p>

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12