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_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         Option bits used for compilation
  PCRE_INFO_SIZE            Size of compiled pattern
  PCRE_INFO_STUDYSIZE       Size of study data
</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	<html>
2	<head>
3	<title>pcre_fullinfo specification</title>
4	</head>
5	<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6	<h1>pcre_fullinfo man page</h1>
7	<p>
8	Return to the <a href="index.html">PCRE index page</a>.
9	</p>
10	<p>
11	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	<br>
15	<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	<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	The following information is available:
37	<pre>
38	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	PCRE_INFO_FIRSTTABLE Table of first bytes
46	(after studying)
47	PCRE_INFO_LASTLITERAL Literal last byte required
48	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	PCRE_INFO_OPTIONS Option bits used for compilation
52	PCRE_INFO_SIZE Size of compiled pattern
53	PCRE_INFO_STUDYSIZE Size of study data
54	</pre>
55	The yield of the function is zero on success or:
56	<pre>
57	PCRE_ERROR_NULL the argument <i>code</i> was NULL
58	the argument <i>where</i> was NULL
59	PCRE_ERROR_BADMAGIC the "magic number" was not found
60	PCRE_ERROR_BADOPTION the value of <i>what</i> was invalid
61	</PRE>
62	</P>
63	<P>
64	There is a complete description of the PCRE native API in the
65	<a href="pcreapi.html"><b>pcreapi</b></a>
66	page and a description of the POSIX API in the
67	<a href="pcreposix.html"><b>pcreposix</b></a>
68	page.
69	<p>
70	Return to the <a href="index.html">PCRE index page</a>.
71	</p>
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"