/[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 79 - (hide annotations) (download)
Sat Feb 24 21:40:52 2007 UTC (7 years, 6 months ago) by nigel
File size: 1999 byte(s)
Load pcre-6.1 into code/trunk.

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12