/[pcre]/code/trunk/doc/pcre_fullinfo.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_fullinfo.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 63 - (show annotations) (download)
Sat Feb 24 21:40:03 2007 UTC (7 years, 7 months ago) by nigel
File size: 1686 byte(s)
Load pcre-4.0 into code/trunk.

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 int pcre_fullinfo(const pcre *\fIcode\fR, "const pcre_extra *\fIextra\fR,"
12 .ti +5n
13 .B int \fIwhat\fR, void *\fIwhere\fR);
14
15 .SH DESCRIPTION
16 .rs
17 .sp
18 This function returns information about a compiled pattern. Its arguments are:
19
20 \fIcode\fR Compiled regular expression
21 \fIextra\fR Result of \fBpcre_study()\fR or NULL
22 \fIwhat\fR What information is required
23 \fIwhere\fR Where to put the information
24
25 The following information is available:
26
27 PCRE_INFO_BACKREFMAX Number of highest back reference
28 PCRE_INFO_CAPTURECOUNT Number of capturing subpatterns
29 PCRE_INFO_FIRSTBYTE Fixed first byte for a match, or
30 -1 for start of string
31 or after newline, or
32 -2 otherwise
33 PCRE_INFO_FIRSTTABLE Table of first bytes
34 (after studying)
35 PCRE_INFO_LASTLITERAL Literal last byte required
36 PCRE_INFO_NAMECOUNT Number of named subpatterns
37 PCRE_INFO_NAMEENTRYSIZE Size of name table entry
38 PCRE_INFO_NAMETABLE Pointer to name table
39 PCRE_INFO_OPTIONS Options used for compilation
40 PCRE_INFO_SIZE Size of compiled pattern
41
42 The yield of the function is zero on success or:
43
44 PCRE_ERROR_NULL the argument \fIcode\fR was NULL
45 the argument \fIwhere\fR was NULL
46 PCRE_ERROR_BADMAGIC the "magic number" was not found
47 PCRE_ERROR_BADOPTION the value of \fIwhat\fR was invalid
48
49 There is a complete description of the PCRE API in the
50 .\" HREF
51 \fBpcreapi\fR
52 .\"
53 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12