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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 868 - (hide annotations) (download)
Fri Jan 13 17:16:32 2012 UTC (2 years, 10 months ago) by ph10
File size: 1419 byte(s)
The last of the 16-bit documentation major updates.

1 nigel 79 .TH PCRE_STUDY 3
2 nigel 63 .SH NAME
3     PCRE - Perl-compatible regular expressions
4     .SH SYNOPSIS
5     .rs
6     .sp
7     .B #include <pcre.h>
8     .PP
9     .SM
10 nigel 75 .B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
11 nigel 63 .ti +5n
12 nigel 75 .B const char **\fIerrptr\fP);
13 ph10 868 .PP
14     .B pcre16_extra *pcre16_study(const pcre16 *\fIcode\fP, int \fIoptions\fP,
15     .ti +5n
16     .B const char **\fIerrptr\fP);
17 nigel 75 .
18 nigel 63 .SH DESCRIPTION
19     .rs
20     .sp
21     This function studies a compiled pattern, to see if additional information can
22     be extracted that might speed up matching. Its arguments are:
23 nigel 75 .sp
24     \fIcode\fP A compiled regular expression
25 ph10 868 \fIoptions\fP Options for \fBpcre[16]_study()\fP
26 nigel 75 \fIerrptr\fP Where to put an error message
27     .sp
28     If the function succeeds, it returns a value that can be passed to
29 ph10 868 \fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP via their \fIextra\fP
30     arguments.
31 nigel 75 .P
32 nigel 63 If the function returns NULL, either it could not find any additional
33     information, or there was an error. You can tell the difference by looking at
34     the error value. It is NULL in first case.
35 nigel 75 .P
36 ph10 691 The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
37     if possible. If PCRE has been compiled without JIT support, this option is
38 ph10 678 ignored. See the
39 ph10 691 .\" HREF
40 ph10 678 \fBpcrejit\fP
41     .\"
42     page for further details.
43 nigel 75 .P
44     There is a complete description of the PCRE native API in the
45 nigel 63 .\" HREF
46 nigel 75 \fBpcreapi\fP
47 nigel 63 .\"
48 nigel 75 page and a description of the POSIX API in the
49     .\" HREF
50     \fBpcreposix\fP
51     .\"
52 nigel 63 page.

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