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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 111 - (hide annotations) (download) (as text)
Thu Mar 8 16:53:09 2007 UTC (7 years, 7 months ago) by ph10
File MIME type: text/html
File size: 3811 byte(s)
Create the PrepareRelease script to process the documentation and create the 
.generic files for distribution, also to remove trailing spaces. Update a lot 
more of the build-time documentation. Arrange for PrepareRelease and its 
sub-scripts to be distributed.

1 nigel 77 <html>
2     <head>
3     <title>pcre_dfa_exec specification</title>
4     </head>
5     <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6     <h1>pcre_dfa_exec man page</h1>
7     <p>
8     Return to the <a href="index.html">PCRE index page</a>.
9     </p>
10 ph10 111 <p>
11 nigel 77 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 ph10 111 <br>
15 nigel 77 <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_dfa_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     <b>int *<i>workspace</i>, int <i>wscount</i>);</b>
26     </P>
27     <br><b>
28     DESCRIPTION
29     </b><br>
30     <P>
31     This function matches a compiled regular expression against a given subject
32 nigel 93 string, using an alternative matching algorithm that scans the subject string
33     just once (<i>not</i> Perl-compatible). Note that the main, Perl-compatible,
34     matching function is <b>pcre_exec()</b>. The arguments for this function are:
35 nigel 77 <pre>
36     <i>code</i> Points to the compiled pattern
37     <i>extra</i> Points to an associated <b>pcre_extra</b> structure,
38     or is NULL
39     <i>subject</i> Points to the subject string
40     <i>length</i> Length of the subject string, in bytes
41     <i>startoffset</i> Offset in bytes in the subject at which to
42     start matching
43     <i>options</i> Option bits
44     <i>ovector</i> Points to a vector of ints for result offsets
45     <i>ovecsize</i> Number of elements in the vector
46     <i>workspace</i> Points to a vector of ints used as working space
47     <i>wscount</i> Number of elements in the vector
48     </pre>
49     The options are:
50     <pre>
51     PCRE_ANCHORED Match only at the first position
52 nigel 93 PCRE_NEWLINE_ANY Recognize any Unicode newline sequence
53 nigel 91 PCRE_NEWLINE_CR Set CR as the newline sequence
54     PCRE_NEWLINE_CRLF Set CRLF as the newline sequence
55     PCRE_NEWLINE_LF Set LF as the newline sequence
56 nigel 77 PCRE_NOTBOL Subject is not the beginning of a line
57     PCRE_NOTEOL Subject is not the end of a line
58     PCRE_NOTEMPTY An empty string is not a valid match
59     PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
60     validity (only relevant if PCRE_UTF8
61     was set at compile time)
62     PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match
63     PCRE_DFA_SHORTEST Return only the shortest match
64     PCRE_DFA_RESTART This is a restart after a partial match
65     </pre>
66 nigel 93 There are restrictions on what may appear in a pattern when using this matching
67     function. Details are given in the
68 nigel 77 <a href="pcrematching.html"><b>pcrematching</b></a>
69     documentation.
70     </P>
71     <P>
72     A <b>pcre_extra</b> structure contains the following fields:
73     <pre>
74     <i>flags</i> Bits indicating which fields are set
75     <i>study_data</i> Opaque data from <b>pcre_study()</b>
76 nigel 87 <i>match_limit</i> Limit on internal resource use
77     <i>match_limit_recursion</i> Limit on internal recursion depth
78 nigel 77 <i>callout_data</i> Opaque data passed back to callouts
79     <i>tables</i> Points to character tables or is NULL
80     </pre>
81     The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
82 nigel 87 PCRE_EXTRA_MATCH_LIMIT_RECURSION, PCRE_EXTRA_CALLOUT_DATA, and
83 nigel 93 PCRE_EXTRA_TABLES. For this matching function, the <i>match_limit</i> and
84 nigel 87 <i>match_limit_recursion</i> fields are not used, and must not be set.
85 nigel 77 </P>
86     <P>
87     There is a complete description of the PCRE native API in the
88     <a href="pcreapi.html"><b>pcreapi</b></a>
89     page and a description of the POSIX API in the
90     <a href="pcreposix.html"><b>pcreposix</b></a>
91     page.
92     <p>
93     Return to the <a href="index.html">PCRE index page</a>.
94     </p>

Properties

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12