| 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 <pcre.h></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 |
nigel |
63 |
PCRE_CASELESS Do caseless matching |
| 47 |
|
|
PCRE_DOLLAR_ENDONLY $ not to match newline at end |
| 48 |
|
|
PCRE_DOTALL . matches anything including NL |
| 49 |
nigel |
91 |
PCRE_DUPNAMES Allow duplicate names for subpatterns |
| 50 |
nigel |
63 |
PCRE_EXTENDED Ignore whitespace and # comments |
| 51 |
|
|
PCRE_EXTRA PCRE extra features |
| 52 |
|
|
(not much use currently) |
| 53 |
nigel |
77 |
PCRE_FIRSTLINE Force matching to be before newline |
| 54 |
nigel |
63 |
PCRE_MULTILINE ^ and $ match newlines within data |
| 55 |
nigel |
93 |
PCRE_NEWLINE_ANY Recognize any Unicode newline sequence |
| 56 |
nigel |
91 |
PCRE_NEWLINE_CR Set CR as the newline sequence |
| 57 |
|
|
PCRE_NEWLINE_CRLF Set CRLF as the newline sequence |
| 58 |
|
|
PCRE_NEWLINE_LF Set LF as the newline sequence |
| 59 |
nigel |
63 |
PCRE_NO_AUTO_CAPTURE Disable numbered capturing paren- |
| 60 |
|
|
theses (named ones available) |
| 61 |
|
|
PCRE_UNGREEDY Invert greediness of quantifiers |
| 62 |
|
|
PCRE_UTF8 Run in UTF-8 mode |
| 63 |
nigel |
71 |
PCRE_NO_UTF8_CHECK Do not check the pattern for UTF-8 |
| 64 |
|
|
validity (only relevant if |
| 65 |
|
|
PCRE_UTF8 is set) |
| 66 |
nigel |
75 |
</pre> |
| 67 |
|
|
PCRE must be built with UTF-8 support in order to use PCRE_UTF8 and |
| 68 |
|
|
PCRE_NO_UTF8_CHECK. |
| 69 |
nigel |
63 |
</P> |
| 70 |
|
|
<P> |
| 71 |
|
|
The yield of the function is a pointer to a private data structure that |
| 72 |
|
|
contains the compiled pattern, or NULL if an error was detected. |
| 73 |
|
|
</P> |
| 74 |
|
|
<P> |
| 75 |
nigel |
75 |
There is a complete description of the PCRE native API in the |
| 76 |
nigel |
63 |
<a href="pcreapi.html"><b>pcreapi</b></a> |
| 77 |
nigel |
75 |
page and a description of the POSIX API in the |
| 78 |
|
|
<a href="pcreposix.html"><b>pcreposix</b></a> |
| 79 |
nigel |
63 |
page. |
| 80 |
nigel |
75 |
<p> |
| 81 |
|
|
Return to the <a href="index.html">PCRE index page</a>. |
| 82 |
|
|
</p> |
Parent Directory
| 
Revision Log