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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 63 by nigel, Sat Feb 24 21:40:03 2007 UTC revision 691 by ph10, Sun Sep 11 14:31:21 2011 UTC
# Line 1  Line 1 
1  .TH PCRE 3  .TH PCRE_STUDY 3
2  .SH NAME  .SH NAME
3  PCRE - Perl-compatible regular expressions  PCRE - Perl-compatible regular expressions
4  .SH SYNOPSIS  .SH SYNOPSIS
# Line 7  PCRE - Perl-compatible regular expressio Line 7  PCRE - Perl-compatible regular expressio
7  .B #include <pcre.h>  .B #include <pcre.h>
8  .PP  .PP
9  .SM  .SM
10  .br  .B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
 .B pcre_extra *pcre_study(const pcre *\fIcode\fR, int \fIoptions\fR,  
11  .ti +5n  .ti +5n
12  .B const char **\fIerrptr\fR);  .B const char **\fIerrptr\fP);
13    .
14  .SH DESCRIPTION  .SH DESCRIPTION
15  .rs  .rs
16  .sp  .sp
17  This function studies a compiled pattern, to see if additional information can  This function studies a compiled pattern, to see if additional information can
18  be extracted that might speed up matching. Its arguments are:  be extracted that might speed up matching. Its arguments are:
19    .sp
20    \fIcode\fR       A compiled regular expression    \fIcode\fP       A compiled regular expression
21    \fIoptions\fR    Options for \fBpcre_study()\fR    \fIoptions\fP    Options for \fBpcre_study()\fP
22    \fIerrptr\fR     Where to put an error message    \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  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  information, or there was an error. You can tell the difference by looking at
29  the error value. It is NULL in first case.  the error value. It is NULL in first case.
30    .P
31  There are currently no options defined; the value of the second argument should  The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
32  always be zero.  if possible. If PCRE has been compiled without JIT support, this option is
33    ignored. See the
34  There is a complete description of the PCRE API in the  .\" 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  .\" HREF
45  \fBpcreapi\fR  \fBpcreposix\fP
46  .\"  .\"
47  page.  page.

Legend:
Removed from v.63  
changed lines
  Added in v.691

  ViewVC Help
Powered by ViewVC 1.1.5