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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 869 - (show annotations)
Sat Jan 14 11:16:23 2012 UTC (7 years, 9 months ago) by ph10
File MIME type: text/html
File size: 1994 byte(s)
Bring HTML docs up to date.
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>
16 SYNOPSIS
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 <br><b>
30 DESCRIPTION
31 </b><br>
32 <P>
33 This function studies a compiled pattern, to see if additional information can
34 be extracted that might speed up matching. Its arguments are:
35 <pre>
36 <i>code</i> A compiled regular expression
37 <i>options</i> Options for <b>pcre[16]_study()</b>
38 <i>errptr</i> Where to put an error message
39 </pre>
40 If the function succeeds, it returns a value that can be passed to
41 <b>pcre[16]_exec()</b> or <b>pcre[16]_dfa_exec()</b> via their <i>extra</i>
42 arguments.
43 </P>
44 <P>
45 If the function returns NULL, either it could not find any additional
46 information, or there was an error. You can tell the difference by looking at
47 the error value. It is NULL in first case.
48 </P>
49 <P>
50 The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
51 if possible. If PCRE has been compiled without JIT support, this option is
52 ignored. See the
53 <a href="pcrejit.html"><b>pcrejit</b></a>
54 page for further details.
55 </P>
56 <P>
57 There is a complete description of the PCRE native API in the
58 <a href="pcreapi.html"><b>pcreapi</b></a>
59 page and a description of the POSIX API in the
60 <a href="pcreposix.html"><b>pcreposix</b></a>
61 page.
62 <p>
63 Return to the <a href="index.html">PCRE index page</a>.
64 </p>

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5