/[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 75 - (show annotations) (download)
Sat Feb 24 21:40:37 2007 UTC (7 years, 7 months ago) by nigel
File size: 2271 byte(s)
Load pcre-5.0 into code/trunk.

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12