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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 93 - (hide annotations) (download)
Sat Feb 24 21:41:42 2007 UTC (7 years, 7 months ago) by nigel
File size: 2702 byte(s)
Load pcre-7.0 into code/trunk.

1 nigel 79 .TH PCRE_EXEC 3
2 nigel 63 .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 nigel 75 .B int pcre_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
12 nigel 63 .ti +5n
13 nigel 75 .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
14 nigel 63 .ti +5n
15 nigel 75 .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);
16     .
17 nigel 63 .SH DESCRIPTION
18     .rs
19     .sp
20     This function matches a compiled regular expression against a given subject
21 nigel 77 string, using a matching algorithm that is similar to Perl's. It returns
22     offsets to captured substrings. Its arguments are:
23 nigel 75 .sp
24     \fIcode\fP Points to the compiled pattern
25     \fIextra\fP Points to an associated \fBpcre_extra\fP structure,
26 nigel 63 or is NULL
27 nigel 75 \fIsubject\fP Points to the subject string
28     \fIlength\fP Length of the subject string, in bytes
29     \fIstartoffset\fP Offset in bytes in the subject at which to
30 nigel 63 start matching
31 nigel 75 \fIoptions\fP Option bits
32     \fIovector\fP Points to a vector of ints for result offsets
33     \fIovecsize\fP Number of elements in the vector (a multiple of 3)
34     .sp
35 nigel 63 The options are:
36 nigel 75 .sp
37 nigel 63 PCRE_ANCHORED Match only at the first position
38 nigel 93 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
39 nigel 91 PCRE_NEWLINE_CR Set CR as the newline sequence
40     PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
41     PCRE_NEWLINE_LF Set LF as the newline sequence
42 nigel 63 PCRE_NOTBOL Subject is not the beginning of a line
43     PCRE_NOTEOL Subject is not the end of a line
44     PCRE_NOTEMPTY An empty string is not a valid match
45 nigel 71 PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
46     validity (only relevant if PCRE_UTF8
47     was set at compile time)
48 nigel 75 PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match
49     .sp
50     There are restrictions on what may appear in a pattern when partial matching is
51 nigel 93 requested. For details, see the
52     .\" HREF
53     \fBpcrepartial\fP
54     .\"
55     page.
56 nigel 75 .P
57     A \fBpcre_extra\fP structure contains the following fields:
58     .sp
59     \fIflags\fP Bits indicating which fields are set
60     \fIstudy_data\fP Opaque data from \fBpcre_study()\fP
61 nigel 87 \fImatch_limit\fP Limit on internal resource use
62     \fImatch_limit_recursion\fP Limit on internal recursion depth
63 nigel 75 \fIcallout_data\fP Opaque data passed back to callouts
64     \fItables\fP Points to character tables or is NULL
65     .sp
66     The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
67 nigel 87 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
68     PCRE_EXTRA_TABLES.
69 nigel 75 .P
70     There is a complete description of the PCRE native API in the
71 nigel 63 .\" HREF
72 nigel 75 \fBpcreapi\fP
73 nigel 63 .\"
74 nigel 75 page and a description of the POSIX API in the
75     .\" HREF
76     \fBpcreposix\fP
77     .\"
78 nigel 63 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12