/[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 77 - (hide annotations) (download) (as text)
Sat Feb 24 21:40:45 2007 UTC (7 years, 2 months ago) by nigel
File MIME type: text/html
File size: 3413 byte(s)
Load pcre-6.0 into code/trunk.

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     <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_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     string, using a DFA matching algorithm (<i>not</i> Perl-compatible). Note that
33     the main, Perl-compatible, matching function is <b>pcre_exec()</b>. The
34     arguments for this function are:
35     <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     PCRE_NOTBOL Subject is not the beginning of a line
53     PCRE_NOTEOL Subject is not the end of a line
54     PCRE_NOTEMPTY An empty string is not a valid match
55     PCRE_NO_UTF8_CHECK Do not check the subject for UTF-8
56     validity (only relevant if PCRE_UTF8
57     was set at compile time)
58     PCRE_PARTIAL Return PCRE_ERROR_PARTIAL for a partial match
59     PCRE_DFA_SHORTEST Return only the shortest match
60     PCRE_DFA_RESTART This is a restart after a partial match
61     </pre>
62     There are restrictions on what may appear in a pattern when matching using the
63     DFA algorithm is requested. Details are given in the
64     <a href="pcrematching.html"><b>pcrematching</b></a>
65     documentation.
66     </P>
67     <P>
68     A <b>pcre_extra</b> structure contains the following fields:
69     <pre>
70     <i>flags</i> Bits indicating which fields are set
71     <i>study_data</i> Opaque data from <b>pcre_study()</b>
72     <i>match_limit</i> Limit on internal recursion
73     <i>callout_data</i> Opaque data passed back to callouts
74     <i>tables</i> Points to character tables or is NULL
75     </pre>
76     The flag bits are PCRE_EXTRA_STUDY_DATA, PCRE_EXTRA_MATCH_LIMIT,
77     PCRE_EXTRA_CALLOUT_DATA, and PCRE_EXTRA_TABLES. For DFA matching, the
78     <i>match_limit</i> field is not used, and must not be set.
79     </P>
80     <P>
81     There is a complete description of the PCRE native API in the
82     <a href="pcreapi.html"><b>pcreapi</b></a>
83     page and a description of the POSIX API in the
84     <a href="pcreposix.html"><b>pcreposix</b></a>
85     page.
86     <p>
87     Return to the <a href="index.html">PCRE index page</a>.
88     </p>

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12