/[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 99 - (show annotations) (download)
Tue Mar 6 12:27:42 2007 UTC (7 years, 8 months ago) by ph10
File size: 1132 byte(s)
1. Move the comment about version numbers from pcre.h.in to configure.ac 
because that's where they are now set.
2. Update all the man pages to remove the use of .br and .in because this
causes trouble for some HTML converters. Also standardised the final sections 
giving author information and revision date.
3. Update the maintain/132html man page converter to handle .nf/.fi and to barf 
at .br/.in.

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 via its \fIextra\fP argument.
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 There are currently no options defined; the value of the second argument should
32 always be zero.
33 .P
34 There is a complete description of the PCRE native API in the
35 .\" HREF
36 \fBpcreapi\fP
37 .\"
38 page and a description of the POSIX API in the
39 .\" HREF
40 \fBpcreposix\fP
41 .\"
42 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