/[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 75 by nigel, Sat Feb 24 21:40:37 2007 UTC
# Line 8  PCRE - Perl-compatible regular expressio Line 8  PCRE - Perl-compatible regular expressio
8  .PP  .PP
9  .SM  .SM
10  .br  .br
11  .B pcre_extra *pcre_study(const pcre *\fIcode\fR, int \fIoptions\fR,  .B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
12  .ti +5n  .ti +5n
13  .B const char **\fIerrptr\fR);  .B const char **\fIerrptr\fP);
14    .
15  .SH DESCRIPTION  .SH DESCRIPTION
16  .rs  .rs
17  .sp  .sp
18  This function studies a compiled pattern, to see if additional information can  This function studies a compiled pattern, to see if additional information can
19  be extracted that might speed up matching. Its arguments are:  be extracted that might speed up matching. Its arguments are:
20    .sp
21    \fIcode\fR       A compiled regular expression    \fIcode\fP       A compiled regular expression
22    \fIoptions\fR    Options for \fBpcre_study()\fR    \fIoptions\fP    Options for \fBpcre_study()\fP
23    \fIerrptr\fR     Where to put an error message    \fIerrptr\fP     Where to put an error message
24    .sp
25    If the function succeeds, it returns a value that can be passed to
26    \fBpcre_exec()\fP via its \fIextra\fP argument.
27    .P
28  If the function returns NULL, either it could not find any additional  If the function returns NULL, either it could not find any additional
29  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
30  the error value. It is NULL in first case.  the error value. It is NULL in first case.
31    .P
32  There are currently no options defined; the value of the second argument should  There are currently no options defined; the value of the second argument should
33  always be zero.  always be zero.
34    .P
35  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
36    .\" HREF
37    \fBpcreapi\fP
38    .\"
39    page and a description of the POSIX API in the
40  .\" HREF  .\" HREF
41  \fBpcreapi\fR  \fBpcreposix\fP
42  .\"  .\"
43  page.  page.
Legend:
Removed from v.63  
changed lines
  Added in v.75
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12