/[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 99 - (show annotations)
Tue Mar 6 12:27:42 2007 UTC (12 years, 8 months ago) by ph10
File size: 2698 byte(s)
Error occurred while calculating annotation data.
1. Move the comment about version numbers from pcre.h.in to configure.ac 
because that's where they are now set.
2. Update all the man pages to remove the use of .br and .in because this
causes trouble for some HTML converters. Also standardised the final sections 
giving author information and revision date.
3. Update the maintain/132html man page converter to handle .nf/.fi and to barf 
at .br/.in.
1 .TH PCRE_EXEC 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 .B int pcre_exec(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
11 .ti +5n
12 .B "const char *\fIsubject\fP," int \fIlength\fP, int \fIstartoffset\fP,
13 .ti +5n
14 .B int \fIoptions\fP, int *\fIovector\fP, int \fIovecsize\fP);
15 .
16 .SH DESCRIPTION
17 .rs
18 .sp
19 This function matches a compiled regular expression against a given subject
20 string, using a matching algorithm that is similar to Perl's. It returns
21 offsets to captured substrings. Its arguments are:
22 .sp
23 \fIcode\fP Points to the compiled pattern
24 \fIextra\fP Points to an associated \fBpcre_extra\fP structure,
25 or is NULL
26 \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 start matching
30 \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 The options are:
35 .sp
36 PCRE_ANCHORED Match only at the first position
37 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
38 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 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 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 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 requested. For details, see the
51 .\" HREF
52 \fBpcrepartial\fP
53 .\"
54 page.
55 .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 \fImatch_limit\fP Limit on internal resource use
61 \fImatch_limit_recursion\fP Limit on internal recursion depth
62 \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 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
67 PCRE_EXTRA_TABLES.
68 .P
69 There is a complete description of the PCRE native API in the
70 .\" HREF
71 \fBpcreapi\fP
72 .\"
73 page and a description of the POSIX API in the
74 .\" HREF
75 \fBpcreposix\fP
76 .\"
77 page.

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

  ViewVC Help
Powered by ViewVC 1.1.5