/[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 461 - (show annotations) (download) (as text)
Mon Oct 5 10:59:35 2009 UTC (5 years ago) by ph10
File MIME type: text/html
File size: 2794 byte(s)
Tidy up, remove trailing spaces, etc. for 8.00-RC1.

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 &#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 <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 (after studying)
46 PCRE_INFO_JCHANGED Return 1 if (?J) or (?-J) was used
47 PCRE_INFO_LASTLITERAL Literal last byte required
48 PCRE_INFO_MINLENGTH Lower bound length of matching strings
49 PCRE_INFO_NAMECOUNT Number of named subpatterns
50 PCRE_INFO_NAMEENTRYSIZE Size of name table entry
51 PCRE_INFO_NAMETABLE Pointer to name table
52 PCRE_INFO_OKPARTIAL Return 1 if partial matching can be tried
53 (always returns 1 after release 8.00)
54 PCRE_INFO_OPTIONS Option bits used for compilation
55 PCRE_INFO_SIZE Size of compiled pattern
56 PCRE_INFO_STUDYSIZE Size of study data
57 </pre>
58 The yield of the function is zero on success or:
59 <pre>
60 PCRE_ERROR_NULL the argument <i>code</i> was NULL
61 the argument <i>where</i> was NULL
62 PCRE_ERROR_BADMAGIC the "magic number" was not found
63 PCRE_ERROR_BADOPTION the value of <i>what</i> was invalid
64 </PRE>
65 </P>
66 <P>
67 There is a complete description of the PCRE native API in the
68 <a href="pcreapi.html"><b>pcreapi</b></a>
69 page and a description of the POSIX API in the
70 <a href="pcreposix.html"><b>pcreposix</b></a>
71 page.
72 <p>
73 Return to the <a href="index.html">PCRE index page</a>.
74 </p>

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12