trunk/doc/pcre_exec.3

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