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_BSR_ANYCRLF       \eR matches only CR, LF, or CRLF
  PCRE_BSR_UNICODE       \eR matches all Unicode line endings
  PCRE_NEWLINE_ANY       Recognize any Unicode newline sequence
  PCRE_NEWLINE_ANYCRLF   Recognize CR, LF, & CRLF as newline sequences
  PCRE_NEWLINE_CR        Recognize CR as the only newline sequence
  PCRE_NEWLINE_CRLF      Recognize CRLF as the only newline sequence
  PCRE_NEWLINE_LF        Recognize LF as the only newline sequence
  PCRE_NOTBOL            Subject string is not the beginning of a line
  PCRE_NOTEOL            Subject string is not the end of a line
  PCRE_NOTEMPTY          An empty string is not a valid match
  PCRE_NOTEMPTY_ATSTART  An empty string at the start of the subject
                           is not a valid match
  PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
  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
  PCRE_PARTIAL_SOFT      )   match if no full matches are found
  PCRE_PARTIAL_HARD      Return PCRE_ERROR_PARTIAL for a partial match
                           even if there is a full match as well
.sp
For details of partial matching, see the
.\" HREF
\fBpcrepartial\fP
.\"
page. 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	ph10	442	PCRE_ANCHORED Match only at the first position
37			PCRE_BSR_ANYCRLF \eR matches only CR, LF, or CRLF
38			PCRE_BSR_UNICODE \eR matches all Unicode line endings
39			PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
40			PCRE_NEWLINE_ANYCRLF Recognize CR, LF, & CRLF as newline sequences
41			PCRE_NEWLINE_CR Recognize CR as the only newline sequence
42			PCRE_NEWLINE_CRLF Recognize CRLF as the only newline sequence
43			PCRE_NEWLINE_LF Recognize LF as the only newline sequence
44			PCRE_NOTBOL Subject string is not the beginning of a line
45			PCRE_NOTEOL Subject string is not the end of a line
46			PCRE_NOTEMPTY An empty string is not a valid match
47			PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject
48			is not a valid match
49			PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
50			PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
51			validity (only relevant if PCRE_UTF8
52			was set at compile time)
53			PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial
54			PCRE_PARTIAL_SOFT ) match if no full matches are found
55	ph10	461	PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match
56			even if there is a full match as well
57	nigel	75	.sp
58	ph10	426	For details of partial matching, see the
59	nigel	93	.\" HREF
60			\fBpcrepartial\fP
61			.\"
62	ph10	428	page. A \fBpcre_extra\fP structure contains the following fields:
63	nigel	75	.sp
64			\fIflags\fP Bits indicating which fields are set
65			\fIstudy_data\fP Opaque data from \fBpcre_study()\fP
66	nigel	87	\fImatch_limit\fP Limit on internal resource use
67			\fImatch_limit_recursion\fP Limit on internal recursion depth
68	nigel	75	\fIcallout_data\fP Opaque data passed back to callouts
69			\fItables\fP Points to character tables or is NULL
70			.sp
71			The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
72	nigel	87	PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
73			PCRE_EXTRA_TABLES.
74	nigel	75	.P
75			There is a complete description of the PCRE native API in the
76	nigel	63	.\" HREF
77	nigel	75	\fBpcreapi\fP
78	nigel	63	.\"
79	nigel	75	page and a description of the POSIX API in the
80			.\" HREF
81			\fBpcreposix\fP
82			.\"
83	nigel	63	page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"