/[pcre]/code/trunk/doc/html/pcre_fullinfo.html
ViewVC logotype

Contents of /code/trunk/doc/html/pcre_fullinfo.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 93 - (hide annotations) (download) (as text)
Sat Feb 24 21:41:42 2007 UTC (7 years, 9 months ago) by nigel
File MIME type: text/html
File size: 2556 byte(s)
Load pcre-7.0 into code/trunk.

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     <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 nigel 63 <br><b>
16     SYNOPSIS
17     </b><br>
18     <P>
19     <b>#include &#60;pcre.h&#62;</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     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 nigel 93 PCRE_INFO_OPTIONS Option bits used for compilation
52 nigel 75 PCRE_INFO_SIZE Size of compiled pattern
53     PCRE_INFO_STUDYSIZE Size of study data
54     </pre>
55 nigel 63 The yield of the function is zero on success or:
56     <pre>
57 nigel 75 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 nigel 63 </PRE>
62     </P>
63     <P>
64 nigel 75 There is a complete description of the PCRE native API in the
65 nigel 63 <a href="pcreapi.html"><b>pcreapi</b></a>
66 nigel 75 page and a description of the POSIX API in the
67     <a href="pcreposix.html"><b>pcreposix</b></a>
68 nigel 63 page.
69 nigel 75 <p>
70     Return to the <a href="index.html">PCRE index page</a>.
71     </p>

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12