| 1 |
.TH PCRE 3 |
.TH PCRE_EXEC 3 |
| 2 |
.SH NAME |
.SH NAME |
| 3 |
PCRE - Perl-compatible regular expressions |
PCRE - Perl-compatible regular expressions |
| 4 |
.SH SYNOPSIS |
.SH SYNOPSIS |
| 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, using a matching algorithm that is similar to Perl's. It returns |
| 22 |
|
offsets to captured substrings. Its arguments are: |
| 23 |
\fIcode\fR Points to the compiled pattern |
.sp |
| 24 |
\fIextra\fR Points to an associated \fBpcre_extra\fR structure, |
\fIcode\fP Points to the compiled pattern |
| 25 |
|
\fIextra\fP Points to an associated \fBpcre_extra\fP structure, |
| 26 |
or is NULL |
or is NULL |
| 27 |
\fIsubject\fR Points to the subject string |
\fIsubject\fP Points to the subject string |
| 28 |
\fIlength\fR Length of the subject string, in bytes |
\fIlength\fP Length of the subject string, in bytes |
| 29 |
\fIstartoffset\fR Offset in bytes in the subject at which to |
\fIstartoffset\fP Offset in bytes in the subject at which to |
| 30 |
start matching |
start matching |
| 31 |
\fIoptions\fR Option bits |
\fIoptions\fP Option bits |
| 32 |
\fIovector\fR Points to a vector of ints for result offsets |
\fIovector\fP Points to a vector of ints for result offsets |
| 33 |
\fIovecsize\fR Size of the vector (a multiple of 3) |
\fIovecsize\fP Number of elements in the vector (a multiple of 3) |
| 34 |
|
.sp |
| 35 |
The options are: |
The options are: |
| 36 |
|
.sp |
| 37 |
PCRE_ANCHORED Match only at the first position |
PCRE_ANCHORED Match only at the first position |
| 38 |
PCRE_NOTBOL Subject is not the beginning of a line |
PCRE_NOTBOL Subject is not the beginning of a line |
| 39 |
PCRE_NOTEOL Subject is not the end of a line |
PCRE_NOTEOL Subject is not the end of a line |
| 41 |
PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8 |
PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8 |
| 42 |
validity (only relevant if PCRE_UTF8 |
validity (only relevant if PCRE_UTF8 |
| 43 |
was set at compile time) |
was set at compile time) |
| 44 |
|
PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match |
| 45 |
There is a complete description of the PCRE API in the |
.sp |
| 46 |
|
There are restrictions on what may appear in a pattern when partial matching is |
| 47 |
|
requested. |
| 48 |
|
.P |
| 49 |
|
A \fBpcre_extra\fP structure contains the following fields: |
| 50 |
|
.sp |
| 51 |
|
\fIflags\fP Bits indicating which fields are set |
| 52 |
|
\fIstudy_data\fP Opaque data from \fBpcre_study()\fP |
| 53 |
|
\fImatch_limit\fP Limit on internal recursion |
| 54 |
|
\fIcallout_data\fP Opaque data passed back to callouts |
| 55 |
|
\fItables\fP Points to character tables or is NULL |
| 56 |
|
.sp |
| 57 |
|
The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT, |
| 58 |
|
PCRE_EXTRA_CALLOUT_DATA, and PCRE_EXTRA_TABLES. |
| 59 |
|
.P |
| 60 |
|
There is a complete description of the PCRE native API in the |
| 61 |
|
.\" HREF |
| 62 |
|
\fBpcreapi\fP |
| 63 |
|
.\" |
| 64 |
|
page and a description of the POSIX API in the |
| 65 |
.\" HREF |
.\" HREF |
| 66 |
\fBpcreapi\fR |
\fBpcreposix\fP |
| 67 |
.\" |
.\" |
| 68 |
page. |
page. |
Parent Directory
| 
Revision Log
| 
Patch