ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1194 - (show annotations)
Wed Oct 31 17:42:29 2012 UTC (6 years, 7 months ago) by ph10
File MIME type: text/html
File size: 2129 byte(s)
More documentation updates
1 <html>
2 <head>
3 <title>pcre_study specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre_study 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>
17 </b><br>
18 <P>
19 <b>#include &#60;pcre.h&#62;</b>
20 </P>
21 <P>
22 <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i>,</b>
23 <b>const char **<i>errptr</i>);</b>
24 </P>
25 <P>
26 <b>pcre16_extra *pcre16_study(const pcre16 *<i>code</i>, int <i>options</i>,</b>
27 <b>const char **<i>errptr</i>);</b>
28 </P>
29 <P>
30 <b>pcre32_extra *pcre32_study(const pcre32 *<i>code</i>, int <i>options</i>,</b>
31 <b>const char **<i>errptr</i>);</b>
32 </P>
33 <br><b>
35 </b><br>
36 <P>
37 This function studies a compiled pattern, to see if additional information can
38 be extracted that might speed up matching. Its arguments are:
39 <pre>
40 <i>code</i> A compiled regular expression
41 <i>options</i> Options for <b>pcre[16|32]_study()</b>
42 <i>errptr</i> Where to put an error message
43 </pre>
44 If the function succeeds, it returns a value that can be passed to
45 <b>pcre[16|32]_exec()</b> or <b>pcre[16|32]_dfa_exec()</b> via their <i>extra</i>
46 arguments.
47 </P>
48 <P>
49 If the function returns NULL, either it could not find any additional
50 information, or there was an error. You can tell the difference by looking at
51 the error value. It is NULL in first case.
52 </P>
53 <P>
54 The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
55 if possible. If PCRE has been compiled without JIT support, this option is
56 ignored. See the
57 <a href="pcrejit.html"><b>pcrejit</b></a>
58 page for further details.
59 </P>
60 <P>
61 There is a complete description of the PCRE native API in the
62 <a href="pcreapi.html"><b>pcreapi</b></a>
63 page and a description of the POSIX API in the
64 <a href="pcreposix.html"><b>pcreposix</b></a>
65 page.
66 <p>
67 Return to the <a href="index.html">PCRE index page</a>.
68 </p>


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

  ViewVC Help
Powered by ViewVC 1.1.5