/[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 691 - (show annotations)
Sun Sep 11 14:31:21 2011 UTC (8 years ago) by ph10
File size: 1289 byte(s)
Final source and document tidies for 8.20-RC1.
1 .TH PCRE_STUDY 3
2 .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 .B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
11 .ti +5n
12 .B const char **\fIerrptr\fP);
13 .
14 .SH DESCRIPTION
15 .rs
16 .sp
17 This function studies a compiled pattern, to see if additional information can
18 be extracted that might speed up matching. Its arguments are:
19 .sp
20 \fIcode\fP A compiled regular expression
21 \fIoptions\fP Options for \fBpcre_study()\fP
22 \fIerrptr\fP Where to put an error message
23 .sp
24 If the function succeeds, it returns a value that can be passed to
25 \fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP via their \fIextra\fP arguments.
26 .P
27 If the function returns NULL, either it could not find any additional
28 information, or there was an error. You can tell the difference by looking at
29 the error value. It is NULL in first case.
30 .P
31 The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
32 if possible. If PCRE has been compiled without JIT support, this option is
33 ignored. See the
34 .\" HREF
35 \fBpcrejit\fP
36 .\"
37 page for further details.
38 .P
39 There is a complete description of the PCRE native API in the
40 .\" HREF
41 \fBpcreapi\fP
42 .\"
43 page and a description of the POSIX API in the
44 .\" HREF
45 \fBpcreposix\fP
46 .\"
47 page.

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5