trunk/doc/pcre_fullinfo.3

.TH PCRE_FULLINFO 3 "24 June 2012" "PCRE 8.30"
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.B int pcre_fullinfo(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
.ti +5n
.B int \fIwhat\fP, void *\fIwhere\fP);
.PP
.B int pcre16_fullinfo(const pcre16 *\fIcode\fP, "const pcre16_extra *\fIextra\fP,"
.ti +5n
.B int \fIwhat\fP, void *\fIwhere\fP);
.PP
.B int pcre32_fullinfo(const pcre32 *\fIcode\fP, "const pcre32_extra *\fIextra\fP,"
.ti +5n
.B int \fIwhat\fP, void *\fIwhere\fP);
.
.SH DESCRIPTION
.rs
.sp
This function returns information about a compiled pattern. Its arguments are:
.sp
  \fIcode\fP                      Compiled regular expression
  \fIextra\fP                     Result of \fBpcre[16|32]_study()\fP or NULL
  \fIwhat\fP                      What information is required
  \fIwhere\fP                     Where to put the information
.sp
The following information is available:
.sp
  PCRE_INFO_BACKREFMAX      Number of highest back reference
  PCRE_INFO_CAPTURECOUNT    Number of capturing subpatterns
  PCRE_INFO_DEFAULT_TABLES  Pointer to default tables
  PCRE_INFO_FIRSTBYTE       Fixed first data unit for a match, or
                              -1 for start of string
                                 or after newline, or
                              -2 otherwise
  PCRE_INFO_FIRSTTABLE      Table of first data units (after studying)
  PCRE_INFO_HASCRORLF       Return 1 if explicit CR or LF matches exist
  PCRE_INFO_JCHANGED        Return 1 if (?J) or (?-J) was used
  PCRE_INFO_JIT             Return 1 after successful JIT compilation
  PCRE_INFO_JITSIZE         Size of JIT compiled code
  PCRE_INFO_LASTLITERAL     Literal last data unit required
  PCRE_INFO_MINLENGTH       Lower bound length of matching strings
  PCRE_INFO_NAMECOUNT       Number of named subpatterns
  PCRE_INFO_NAMEENTRYSIZE   Size of name table entry
  PCRE_INFO_NAMETABLE       Pointer to name table
  PCRE_INFO_OKPARTIAL       Return 1 if partial matching can be tried
                              (always returns 1 after release 8.00)
  PCRE_INFO_OPTIONS         Option bits used for compilation
  PCRE_INFO_SIZE            Size of compiled pattern
  PCRE_INFO_STUDYSIZE       Size of study data
  PCRE_INFO_FIRSTCHARACTER      Fixed first data unit for a match
  PCRE_INFO_FIRSTCHARACTERFLAGS Returns
                                  1 if there is a first data character set, which can
                                    then be retrieved using PCRE_INFO_FIRSTCHARACTER,
                                  2 if the first character is at the start of the data
                                    string or after a newline, and
                                  0 otherwise
  PCRE_INFO_REQUIREDCHAR      Literal last data unit required
  PCRE_INFO_REQUIREDCHARFLAGS Returns 1 if the last data character is set (which can then
                              be retrieved using PCRE_INFO_REQUIREDCHAR); 0 otherwise
.sp
The \fIwhere\fP argument must point to an integer variable, except for the
following \fIwhat\fP values:
.sp
  PCRE_INFO_DEFAULT_TABLES  const unsigned char *
  PCRE_INFO_FIRSTTABLE      const unsigned char *
  PCRE_INFO_NAMETABLE       PCRE_SPTR16           (16-bit library)
  PCRE_INFO_NAMETABLE       PCRE_SPTR32           (32-bit library)
  PCRE_INFO_NAMETABLE       const unsigned char * (8-bit library)
  PCRE_INFO_OPTIONS         unsigned long int
  PCRE_INFO_SIZE            size_t
  PCRE_INFO_FIRSTCHARACTER  uint32_t
  PCRE_INFO_REQUIREDCHAR    uint32_t
.sp
The yield of the function is zero on success or:
.sp
  PCRE_ERROR_NULL           the argument \fIcode\fP was NULL
                            the argument \fIwhere\fP was NULL
  PCRE_ERROR_BADMAGIC       the "magic number" was not found
  PCRE_ERROR_BADOPTION      the value of \fIwhat\fP was invalid
.P
There is a complete description of the PCRE native API in the
.\" HREF
\fBpcreapi\fP
.\"
page and a description of the POSIX API in the
.\" HREF
\fBpcreposix\fP
.\"
page.
1	chpe	1055	.TH PCRE_FULLINFO 3 "24 June 2012" "PCRE 8.30"
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	nigel	75	.B int pcre_fullinfo(const pcre \fIcode\fP, "const pcre_extra \fIextra\fP,"
11	nigel	63	.ti +5n
12	nigel	75	.B int \fIwhat\fP, void *\fIwhere\fP);
13	ph10	868	.PP
14			.B int pcre16_fullinfo(const pcre16 \fIcode\fP, "const pcre16_extra \fIextra\fP,"
15			.ti +5n
16			.B int \fIwhat\fP, void *\fIwhere\fP);
17	chpe	1055	.PP
18			.B int pcre32_fullinfo(const pcre32 \fIcode\fP, "const pcre32_extra \fIextra\fP,"
19			.ti +5n
20			.B int \fIwhat\fP, void *\fIwhere\fP);
21	nigel	75	.
22	nigel	63	.SH DESCRIPTION
23			.rs
24			.sp
25			This function returns information about a compiled pattern. Its arguments are:
26	nigel	75	.sp
27			\fIcode\fP Compiled regular expression
28	chpe	1055	\fIextra\fP Result of \fBpcre[16\|32]_study()\fP or NULL
29	nigel	75	\fIwhat\fP What information is required
30			\fIwhere\fP Where to put the information
31			.sp
32	nigel	63	The following information is available:
33	nigel	75	.sp
34			PCRE_INFO_BACKREFMAX Number of highest back reference
35			PCRE_INFO_CAPTURECOUNT Number of capturing subpatterns
36			PCRE_INFO_DEFAULT_TABLES Pointer to default tables
37	ph10	868	PCRE_INFO_FIRSTBYTE Fixed first data unit for a match, or
38	nigel	75	-1 for start of string
39			or after newline, or
40			-2 otherwise
41	ph10	868	PCRE_INFO_FIRSTTABLE Table of first data units (after studying)
42	ph10	678	PCRE_INFO_HASCRORLF Return 1 if explicit CR or LF matches exist
43	ph10	278	PCRE_INFO_JCHANGED Return 1 if (?J) or (?-J) was used
44	ph10	678	PCRE_INFO_JIT Return 1 after successful JIT compilation
45	ph10	903	PCRE_INFO_JITSIZE Size of JIT compiled code
46	ph10	868	PCRE_INFO_LASTLITERAL Literal last data unit required
47	ph10	461	PCRE_INFO_MINLENGTH Lower bound length of matching strings
48	nigel	75	PCRE_INFO_NAMECOUNT Number of named subpatterns
49			PCRE_INFO_NAMEENTRYSIZE Size of name table entry
50			PCRE_INFO_NAMETABLE Pointer to name table
51	ph10	182	PCRE_INFO_OKPARTIAL Return 1 if partial matching can be tried
52	ph10	426	(always returns 1 after release 8.00)
53	nigel	93	PCRE_INFO_OPTIONS Option bits used for compilation
54	nigel	75	PCRE_INFO_SIZE Size of compiled pattern
55			PCRE_INFO_STUDYSIZE Size of study data
56	chpe	1113	PCRE_INFO_FIRSTCHARACTER Fixed first data unit for a match
57			PCRE_INFO_FIRSTCHARACTERFLAGS Returns
58			1 if there is a first data character set, which can
59			then be retrieved using PCRE_INFO_FIRSTCHARACTER,
60			2 if the first character is at the start of the data
61			string or after a newline, and
62			0 otherwise
63			PCRE_INFO_REQUIREDCHAR Literal last data unit required
64			PCRE_INFO_REQUIREDCHARFLAGS Returns 1 if the last data character is set (which can then
65			be retrieved using PCRE_INFO_REQUIREDCHAR); 0 otherwise
66	nigel	75	.sp
67	ph10	691	The \fIwhere\fP argument must point to an integer variable, except for the
68	ph10	678	following \fIwhat\fP values:
69			.sp
70			PCRE_INFO_DEFAULT_TABLES const unsigned char *
71			PCRE_INFO_FIRSTTABLE const unsigned char *
72	ph10	868	PCRE_INFO_NAMETABLE PCRE_SPTR16 (16-bit library)
73	chpe	1055	PCRE_INFO_NAMETABLE PCRE_SPTR32 (32-bit library)
74	ph10	868	PCRE_INFO_NAMETABLE const unsigned char * (8-bit library)
75	ph10	678	PCRE_INFO_OPTIONS unsigned long int
76	ph10	691	PCRE_INFO_SIZE size_t
77	chpe	1113	PCRE_INFO_FIRSTCHARACTER uint32_t
78			PCRE_INFO_REQUIREDCHAR uint32_t
79	ph10	678	.sp
80	nigel	63	The yield of the function is zero on success or:
81	nigel	75	.sp
82			PCRE_ERROR_NULL the argument \fIcode\fP was NULL
83			the argument \fIwhere\fP was NULL
84			PCRE_ERROR_BADMAGIC the "magic number" was not found
85			PCRE_ERROR_BADOPTION the value of \fIwhat\fP was invalid
86			.P
87			There is a complete description of the PCRE native API in the
88	nigel	63	.\" HREF
89	nigel	75	\fBpcreapi\fP
90	nigel	63	.\"
91	nigel	75	page and a description of the POSIX API in the
92			.\" HREF
93			\fBpcreposix\fP
94			.\"
95	nigel	63	page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"