doc/html/pcre_fullinfo.html

<html>
<head>
<title>pcre_fullinfo specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre_fullinfo man page</h1>
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
<p>
This page is part of the PCRE HTML documentation. It was generated automatically
from the original man page. If there is any nonsense in it, please consult the
man page, in case the conversion went wrong.
<br>
<br><b>
SYNOPSIS
</b><br>
<P>
<b>#include &#60;pcre.h&#62;</b>
</P>
<P>
<b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
<b>int <i>what</i>, void *<i>where</i>);</b>
</P>
<br><b>
DESCRIPTION
</b><br>
<P>
This function returns information about a compiled pattern. Its arguments are:
<pre>
  <i>code</i>                      Compiled regular expression
  <i>extra</i>                     Result of <b>pcre_study()</b> or NULL
  <i>what</i>                      What information is required
  <i>where</i>                     Where to put the information
</pre>
The following information is available:
<pre>
  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 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_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_LASTLITERAL     Literal last byte 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
</pre>
The <i>where</i> argument must point to an integer variable, except for the
following <i>what</i> values:
<pre>
  PCRE_INFO_DEFAULT_TABLES  const unsigned char *
  PCRE_INFO_FIRSTTABLE      const unsigned char *
  PCRE_INFO_NAMETABLE       const unsigned char *
  PCRE_INFO_OPTIONS         unsigned long int
  PCRE_INFO_SIZE            size_t
</pre>
The yield of the function is zero on success or:
<pre>
  PCRE_ERROR_NULL           the argument <i>code</i> was NULL
                            the argument <i>where</i> was NULL
  PCRE_ERROR_BADMAGIC       the "magic number" was not found
  PCRE_ERROR_BADOPTION      the value of <i>what</i> was invalid
</PRE>
</P>
<P>
There is a complete description of the PCRE native API in the
<a href="pcreapi.html"><b>pcreapi</b></a>
page and a description of the POSIX API in the
<a href="pcreposix.html"><b>pcreposix</b></a>
page.
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
1	nigel	63	<html>
2			<head>
3			<title>pcre_fullinfo specification</title>
4			</head>
5			<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6	nigel	75	<h1>pcre_fullinfo man page</h1>
7			<p>
8			Return to the <a href="index.html">PCRE index page</a>.
9			</p>
10	ph10	111	<p>
11	nigel	75	This page is part of the PCRE HTML documentation. It was generated automatically
12			from the original man page. If there is any nonsense in it, please consult the
13			man page, in case the conversion went wrong.
14	ph10	111	<br>
15	nigel	63	<br><b>
16			SYNOPSIS
17			</b><br>
18			<P>
19			<b>#include <pcre.h></b>
20			</P>
21			<P>
22			<b>int pcre_fullinfo(const pcre <i>code</i>, const pcre_extra <i>extra</i>,</b>
23			<b>int <i>what</i>, void *<i>where</i>);</b>
24			</P>
25			<br><b>
26			DESCRIPTION
27			</b><br>
28			<P>
29			This function returns information about a compiled pattern. Its arguments are:
30			<pre>
31	nigel	75	<i>code</i> Compiled regular expression
32			<i>extra</i> Result of <b>pcre_study()</b> or NULL
33			<i>what</i> What information is required
34			<i>where</i> Where to put the information
35			</pre>
36	nigel	63	The following information is available:
37			<pre>
38	nigel	75	PCRE_INFO_BACKREFMAX Number of highest back reference
39			PCRE_INFO_CAPTURECOUNT Number of capturing subpatterns
40			PCRE_INFO_DEFAULT_TABLES Pointer to default tables
41			PCRE_INFO_FIRSTBYTE Fixed first byte for a match, or
42			-1 for start of string
43			or after newline, or
44			-2 otherwise
45	ph10	182	PCRE_INFO_FIRSTTABLE Table of first bytes (after studying)
46	ph10	691	PCRE_INFO_HASCRORLF Return 1 if explicit CR or LF matches exist
47	ph10	286	PCRE_INFO_JCHANGED Return 1 if (?J) or (?-J) was used
48	ph10	691	PCRE_INFO_JIT Return 1 after successful JIT compilation
49	nigel	75	PCRE_INFO_LASTLITERAL Literal last byte required
50	ph10	461	PCRE_INFO_MINLENGTH Lower bound length of matching strings
51	nigel	75	PCRE_INFO_NAMECOUNT Number of named subpatterns
52			PCRE_INFO_NAMEENTRYSIZE Size of name table entry
53			PCRE_INFO_NAMETABLE Pointer to name table
54	ph10	182	PCRE_INFO_OKPARTIAL Return 1 if partial matching can be tried
55	ph10	429	(always returns 1 after release 8.00)
56	nigel	93	PCRE_INFO_OPTIONS Option bits used for compilation
57	nigel	75	PCRE_INFO_SIZE Size of compiled pattern
58			PCRE_INFO_STUDYSIZE Size of study data
59			</pre>
60	ph10	691	The <i>where</i> argument must point to an integer variable, except for the
61			following <i>what</i> values:
62			<pre>
63			PCRE_INFO_DEFAULT_TABLES const unsigned char *
64			PCRE_INFO_FIRSTTABLE const unsigned char *
65			PCRE_INFO_NAMETABLE const unsigned char *
66			PCRE_INFO_OPTIONS unsigned long int
67			PCRE_INFO_SIZE size_t
68			</pre>
69	nigel	63	The yield of the function is zero on success or:
70			<pre>
71	nigel	75	PCRE_ERROR_NULL the argument <i>code</i> was NULL
72			the argument <i>where</i> was NULL
73			PCRE_ERROR_BADMAGIC the "magic number" was not found
74			PCRE_ERROR_BADOPTION the value of <i>what</i> was invalid
75	nigel	63	</PRE>
76			</P>
77			<P>
78	nigel	75	There is a complete description of the PCRE native API in the
79	nigel	63	<a href="pcreapi.html"><b>pcreapi</b></a>
80	nigel	75	page and a description of the POSIX API in the
81			<a href="pcreposix.html"><b>pcreposix</b></a>
82	nigel	63	page.
83	nigel	75	<p>
84			Return to the <a href="index.html">PCRE index page</a>.
85			</p>
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"