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

Contents of /code/trunk/doc/html/pcre_exec.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1194 - (show annotations)
Wed Oct 31 17:42:29 2012 UTC (6 years, 9 months ago) by ph10
File MIME type: text/html
File size: 4891 byte(s)
More documentation updates
1 <html>
2 <head>
3 <title>pcre_exec specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre_exec man page</h1>
7 <p>
8 Return to the <a href="index.html">PCRE index page</a>.
9 </p>
10 <p>
11 This page is part of the PCRE HTML documentation. It was generated automatically
12 from the original man page. If there is any nonsense in it, please consult the
13 man page, in case the conversion went wrong.
14 <br>
15 <br><b>
16 SYNOPSIS
17 </b><br>
18 <P>
19 <b>#include &#60;pcre.h&#62;</b>
20 </P>
21 <P>
22 <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
23 <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
24 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b>
25 </P>
26 <P>
27 <b>int pcre16_exec(const pcre16 *<i>code</i>, const pcre16_extra *<i>extra</i>,</b>
28 <b>PCRE_SPTR16 <i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
29 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b>
30 </P>
31 <P>
32 <b>int pcre32_exec(const pcre32 *<i>code</i>, const pcre32_extra *<i>extra</i>,</b>
33 <b>PCRE_SPTR32 <i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
34 <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b>
35 </P>
36 <br><b>
37 DESCRIPTION
38 </b><br>
39 <P>
40 This function matches a compiled regular expression against a given subject
41 string, using a matching algorithm that is similar to Perl's. It returns
42 offsets to captured substrings. Its arguments are:
43 <pre>
44 <i>code</i> Points to the compiled pattern
45 <i>extra</i> Points to an associated <b>pcre[16|32]_extra</b> structure,
46 or is NULL
47 <i>subject</i> Points to the subject string
48 <i>length</i> Length of the subject string, in bytes
49 <i>startoffset</i> Offset in bytes in the subject at which to
50 start matching
51 <i>options</i> Option bits
52 <i>ovector</i> Points to a vector of ints for result offsets
53 <i>ovecsize</i> Number of elements in the vector (a multiple of 3)
54 </pre>
55 The options are:
56 <pre>
57 PCRE_ANCHORED Match only at the first position
58 PCRE_BSR_ANYCRLF \R matches only CR, LF, or CRLF
59 PCRE_BSR_UNICODE \R matches all Unicode line endings
60 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
61 PCRE_NEWLINE_ANYCRLF Recognize CR, LF, & CRLF as newline sequences
62 PCRE_NEWLINE_CR Recognize CR as the only newline sequence
63 PCRE_NEWLINE_CRLF Recognize CRLF as the only newline sequence
64 PCRE_NEWLINE_LF Recognize LF as the only newline sequence
65 PCRE_NOTBOL Subject string is not the beginning of a line
66 PCRE_NOTEOL Subject string is not the end of a line
67 PCRE_NOTEMPTY An empty string is not a valid match
68 PCRE_NOTEMPTY_ATSTART An empty string at the start of the subject
69 is not a valid match
70 PCRE_NO_START_OPTIMIZE Do not do "start-match" optimizations
71 PCRE_NO_UTF16_CHECK Do not check the subject for UTF-16
72 validity (only relevant if PCRE_UTF16
73 was set at compile time)
74 PCRE_NO_UTF32_CHECK Do not check the subject for UTF-32
75 validity (only relevant if PCRE_UTF32
76 was set at compile time)
77 PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
78 validity (only relevant if PCRE_UTF8
79 was set at compile time)
80 PCRE_PARTIAL ) Return PCRE_ERROR_PARTIAL for a partial
81 PCRE_PARTIAL_SOFT ) match if no full matches are found
82 PCRE_PARTIAL_HARD Return PCRE_ERROR_PARTIAL for a partial match
83 if that is found before a full match
84 </pre>
85 For details of partial matching, see the
86 <a href="pcrepartial.html"><b>pcrepartial</b></a>
87 page. A <b>pcre_extra</b> structure contains the following fields:
88 <pre>
89 <i>flags</i> Bits indicating which fields are set
90 <i>study_data</i> Opaque data from <b>pcre[16|32]_study()</b>
91 <i>match_limit</i> Limit on internal resource use
92 <i>match_limit_recursion</i> Limit on internal recursion depth
93 <i>callout_data</i> Opaque data passed back to callouts
94 <i>tables</i> Points to character tables or is NULL
95 <i>mark</i> For passing back a *MARK pointer
96 <i>executable_jit</i> Opaque data from JIT compilation
97 </pre>
98 The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
99 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA,
100 PCRE_EXTRA_TABLES, PCRE_EXTRA_MARK and PCRE_EXTRA_EXECUTABLE_JIT.
101 </P>
102 <P>
103 There is a complete description of the PCRE native API in the
104 <a href="pcreapi.html"><b>pcreapi</b></a>
105 page and a description of the POSIX API in the
106 <a href="pcreposix.html"><b>pcreposix</b></a>
107 page.
108 <p>
109 Return to the <a href="index.html">PCRE index page</a>.
110 </p>

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5