trunk/doc/pcre_study.3

.TH PCRE 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.br
.B pcre_extra *pcre_study(const pcre *\fIcode\fR, int \fIoptions\fR,
.ti +5n
.B const char **\fIerrptr\fR);

.SH DESCRIPTION
.rs
.sp
This function studies a compiled pattern, to see if additional information can
be extracted that might speed up matching. Its arguments are:

  \fIcode\fR       A compiled regular expression
  \fIoptions\fR    Options for \fBpcre_study()\fR
  \fIerrptr\fR     Where to put an error message

If the function returns NULL, either it could not find any additional
information, or there was an error. You can tell the difference by looking at
the error value. It is NULL in first case.

There are currently no options defined; the value of the second argument should
always be zero.

There is a complete description of the PCRE API in the
.\" HREF
\fBpcreapi\fR
.\"
page.
1	.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.