/[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 96 - (show annotations) (download)
Fri Mar 2 13:10:43 2007 UTC (7 years, 9 months ago) by nigel
File size: 1136 byte(s)
 r6896@hex:  nm | 2007-03-02 13:09:14 +0000
 Added EOL and keywork properties throughout

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 .br
11 .B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
12 .ti +5n
13 .B const char **\fIerrptr\fP);
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 .sp
21 \fIcode\fP A compiled regular expression
22 \fIoptions\fP Options for \fBpcre_study()\fP
23 \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
29 information, or there was an error. You can tell the difference by looking at
30 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
33 always be zero.
34 .P
35 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
41 \fBpcreposix\fP
42 .\"
43 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