/[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 63 - (hide annotations) (download)
Sat Feb 24 21:40:03 2007 UTC (7 years, 1 month ago) by nigel
File size: 918 byte(s)
Load pcre-4.0 into code/trunk.

1 nigel 63 .TH PCRE 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     .br
11     .B pcre_extra *pcre_study(const pcre *\fIcode\fR, int \fIoptions\fR,
12     .ti +5n
13     .B const char **\fIerrptr\fR);
14    
15     .SH DESCRIPTION
16     .rs
17     .sp
18     This function studies a compiled pattern, to see if additional information can
19     be extracted that might speed up matching. Its arguments are:
20    
21     \fIcode\fR A compiled regular expression
22     \fIoptions\fR Options for \fBpcre_study()\fR
23     \fIerrptr\fR Where to put an error message
24    
25     If the function returns NULL, either it could not find any additional
26     information, or there was an error. You can tell the difference by looking at
27     the error value. It is NULL in first case.
28    
29     There are currently no options defined; the value of the second argument should
30     always be zero.
31    
32     There is a complete description of the PCRE API in the
33     .\" HREF
34     \fBpcreapi\fR
35     .\"
36     page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12