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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 71 by nigel, Sat Feb 24 21:40:24 2007 UTC revision 75 by nigel, Sat Feb 24 21:40:37 2007 UTC
# Line 8  PCRE - Perl-compatible regular expressio Line 8  PCRE - Perl-compatible regular expressio
8  .PP  .PP
9  .SM  .SM
10  .br  .br
11  .B int pcre_exec(const pcre *\fIcode\fR, "const pcre_extra *\fIextra\fR,"  .B int pcre_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
12  .ti +5n  .ti +5n
13  .B "const char *\fIsubject\fR," int \fIlength\fR, int \fIstartoffset\fR,  .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
14  .ti +5n  .ti +5n
15  .B int \fIoptions\fR, int *\fIovector\fR, int \fIovecsize\fR);  .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);
16    .
17  .SH DESCRIPTION  .SH DESCRIPTION
18  .rs  .rs
19  .sp  .sp
20  This function matches a compiled regular expression against a given subject  This function matches a compiled regular expression against a given subject
21  string, and returns offsets to capturing subexpressions. Its arguments are:  string, and returns offsets to capturing subexpressions. Its arguments are:
22    .sp
23    \fIcode\fR         Points to the compiled pattern    \fIcode\fP         Points to the compiled pattern
24    \fIextra\fR        Points to an associated \fBpcre_extra\fR structure,    \fIextra\fP        Points to an associated \fBpcre_extra\fP structure,
25                   or is NULL                   or is NULL
26    \fIsubject\fR      Points to the subject string    \fIsubject\fP      Points to the subject string
27    \fIlength\fR       Length of the subject string, in bytes    \fIlength\fP       Length of the subject string, in bytes
28    \fIstartoffset\fR  Offset in bytes in the subject at which to    \fIstartoffset\fP  Offset in bytes in the subject at which to
29                   start matching                   start matching
30    \fIoptions\fR      Option bits    \fIoptions\fP      Option bits
31    \fIovector\fR      Points to a vector of ints for result offsets    \fIovector\fP      Points to a vector of ints for result offsets
32    \fIovecsize\fR     Size of the vector (a multiple of 3)    \fIovecsize\fP     Number of elements in the vector (a multiple of 3)
33    .sp
34  The options are:  The options are:
35    .sp
36    PCRE_ANCHORED      Match only at the first position    PCRE_ANCHORED      Match only at the first position
37    PCRE_NOTBOL        Subject is not the beginning of a line    PCRE_NOTBOL        Subject is not the beginning of a line
38    PCRE_NOTEOL        Subject is not the end of a line    PCRE_NOTEOL        Subject is not the end of a line
# Line 40  The options are: Line 40  The options are:
40    PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8    PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
41                         validity (only relevant if PCRE_UTF8                         validity (only relevant if PCRE_UTF8
42                         was set at compile time)                         was set at compile time)
43      PCRE_PARTIAL       Return PCRE_ERROR_PARTIAL for a partial match
44  There is a complete description of the PCRE API in the  .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  .\" HREF
65  \fBpcreapi\fR  \fBpcreposix\fP
66  .\"  .\"
67  page.  page.

Legend:
Removed from v.71  
changed lines
  Added in v.75

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12