/[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 461 - (show annotations) (download)
Mon Oct 5 10:59:35 2009 UTC (4 years, 10 months ago) by ph10
File size: 2237 byte(s)
Tidy up, remove trailing spaces, etc. for 8.00-RC1.

1 .TH PCRE_FULLINFO 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 int pcre_fullinfo(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
11 .ti +5n
12 .B int \fIwhat\fP, void *\fIwhere\fP);
13 .
14 .SH DESCRIPTION
15 .rs
16 .sp
17 This function returns information about a compiled pattern. Its arguments are:
18 .sp
19 \fIcode\fP Compiled regular expression
20 \fIextra\fP Result of \fBpcre_study()\fP or NULL
21 \fIwhat\fP What information is required
22 \fIwhere\fP Where to put the information
23 .sp
24 The following information is available:
25 .sp
26 PCRE_INFO_BACKREFMAX Number of highest back reference
27 PCRE_INFO_CAPTURECOUNT Number of capturing subpatterns
28 PCRE_INFO_DEFAULT_TABLES Pointer to default tables
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 (after studying)
34 PCRE_INFO_JCHANGED Return 1 if (?J) or (?-J) was used
35 PCRE_INFO_LASTLITERAL Literal last byte required
36 PCRE_INFO_MINLENGTH Lower bound length of matching strings
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_OKPARTIAL Return 1 if partial matching can be tried
41 (always returns 1 after release 8.00)
42 PCRE_INFO_OPTIONS Option bits used for compilation
43 PCRE_INFO_SIZE Size of compiled pattern
44 PCRE_INFO_STUDYSIZE Size of study data
45 .sp
46 The yield of the function is zero on success or:
47 .sp
48 PCRE_ERROR_NULL the argument \fIcode\fP was NULL
49 the argument \fIwhere\fP was NULL
50 PCRE_ERROR_BADMAGIC the "magic number" was not found
51 PCRE_ERROR_BADOPTION the value of \fIwhat\fP was invalid
52 .P
53 There is a complete description of the PCRE native API in the
54 .\" HREF
55 \fBpcreapi\fP
56 .\"
57 page and a description of the POSIX API in the
58 .\" HREF
59 \fBpcreposix\fP
60 .\"
61 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