/[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 1339 - (hide annotations) (download) (as text)
Fri Jun 14 09:09:28 2013 UTC (13 months, 1 week ago) by ph10
File MIME type: text/html
File size: 2146 byte(s)
Update man pages to avoid the use of .ti (which causes difficulties for some 
translation software).

1 nigel 63 <html>
2     <head>
3     <title>pcre_study specification</title>
4     </head>
5     <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 nigel 75 <h1>pcre_study 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 75 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 63 <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 ph10 1339 <b> const char **<i>errptr</i>);</b>
24     <br>
25     <br>
26 ph10 869 <b>pcre16_extra *pcre16_study(const pcre16 *<i>code</i>, int <i>options</i>,</b>
27 ph10 1339 <b> const char **<i>errptr</i>);</b>
28     <br>
29     <br>
30 ph10 1194 <b>pcre32_extra *pcre32_study(const pcre32 *<i>code</i>, int <i>options</i>,</b>
31 ph10 1339 <b> const char **<i>errptr</i>);</b>
32 ph10 1194 </P>
33 nigel 63 <br><b>
34     DESCRIPTION
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 ph10 1194 <i>options</i> Options for <b>pcre[16|32]_study()</b>
42 nigel 63 <i>errptr</i> Where to put an error message
43 nigel 75 </pre>
44     If the function succeeds, it returns a value that can be passed to
45 ph10 1194 <b>pcre[16|32]_exec()</b> or <b>pcre[16|32]_dfa_exec()</b> via their <i>extra</i>
46 ph10 869 arguments.
47 nigel 63 </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 ph10 691 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 nigel 63 </P>
60     <P>
61 nigel 75 There is a complete description of the PCRE native API in the
62 nigel 63 <a href="pcreapi.html"><b>pcreapi</b></a>
63 nigel 75 page and a description of the POSIX API in the
64     <a href="pcreposix.html"><b>pcreposix</b></a>
65 nigel 63 page.
66 nigel 75 <p>
67     Return to the <a href="index.html">PCRE index page</a>.
68     </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