trunk/doc/pcre_fullinfo.3

.TH PCRE 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.br
.B int pcre_fullinfo(const pcre *\fIcode\fR, "const pcre_extra *\fIextra\fR,"
.ti +5n
.B int \fIwhat\fR, void *\fIwhere\fR);

.SH DESCRIPTION
.rs
.sp
This function returns information about a compiled pattern. Its arguments are:

  \fIcode\fR    Compiled regular expression
  \fIextra\fR   Result of \fBpcre_study()\fR or NULL
  \fIwhat\fR    What information is required
  \fIwhere\fR   Where to put the information

The following information is available:

  PCRE_INFO_BACKREFMAX     Number of highest back reference
  PCRE_INFO_CAPTURECOUNT   Number of capturing subpatterns
  PCRE_INFO_FIRSTBYTE      Fixed first byte for a match, or
                             -1 for start of string
                                or after newline, or
                             -2 otherwise
  PCRE_INFO_FIRSTTABLE     Table of first bytes
                             (after studying)
  PCRE_INFO_LASTLITERAL    Literal last byte required
  PCRE_INFO_NAMECOUNT      Number of named subpatterns
  PCRE_INFO_NAMEENTRYSIZE  Size of name table entry
  PCRE_INFO_NAMETABLE      Pointer to name table
  PCRE_INFO_OPTIONS        Options used for compilation
  PCRE_INFO_SIZE           Size of compiled pattern

The yield of the function is zero on success or:

  PCRE_ERROR_NULL       the argument \fIcode\fR was NULL
                        the argument \fIwhere\fR was NULL
  PCRE_ERROR_BADMAGIC   the "magic number" was not found
  PCRE_ERROR_BADOPTION  the value of \fIwhat\fR was invalid

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 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.