/[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 63 - (hide annotations) (download)
Sat Feb 24 21:40:03 2007 UTC (7 years, 9 months ago) by nigel
File size: 1372 byte(s)
Load pcre-4.0 into code/trunk.

1 nigel 63 .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\fR, "const pcre_extra *\fIextra\fR,"
12     .ti +5n
13     .B "const char *\fIsubject\fR," int \fIlength\fR, int \fIstartoffset\fR,
14     .ti +5n
15     .B int \fIoptions\fR, int *\fIovector\fR, int \fIovecsize\fR);
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    
23     \fIcode\fR Points to the compiled pattern
24     \fIextra\fR Points to an associated \fBpcre_extra\fR structure,
25     or is NULL
26     \fIsubject\fR Points to the subject string
27     \fIlength\fR Length of the subject string, in bytes
28     \fIstartoffset\fR Offset in bytes in the subject at which to
29     start matching
30     \fIoptions\fR Option bits
31     \fIovector\fR Points to a vector of ints for result offsets
32     \fIovecsize\fR Size of the vector (a multiple of 3)
33    
34     The options are:
35    
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    
41     There is a complete description of the PCRE API in the
42     .\" HREF
43     \fBpcreapi\fR
44     .\"
45     page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12