summaryrefslogtreecommitdiff
path: root/doc/html/pcre_fullinfo.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/pcre_fullinfo.html')
-rw-r--r--doc/html/pcre_fullinfo.html68
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/html/pcre_fullinfo.html b/doc/html/pcre_fullinfo.html
new file mode 100644
index 0000000..f43fa65
--- /dev/null
+++ b/doc/html/pcre_fullinfo.html
@@ -0,0 +1,68 @@
+<html>
+<head>
+<title>pcre_fullinfo specification</title>
+</head>
+<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
+This HTML document has been 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:
+</P>
+<P>
+<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>
+</P>
+<P>
+The following information is available:
+</P>
+<P>
+<pre>
+ 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
+</PRE>
+</P>
+<P>
+The yield of the function is zero on success or:
+</P>
+<P>
+<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 API in the
+<a href="pcreapi.html"><b>pcreapi</b></a>
+page.