60 lines
2.0 KiB
Groff
60 lines
2.0 KiB
Groff
.TH PCRE_FULLINFO 3
|
|
.SH NAME
|
|
PCRE - Perl-compatible regular expressions
|
|
.SH SYNOPSIS
|
|
.rs
|
|
.sp
|
|
.B #include <pcre.h>
|
|
.PP
|
|
.SM
|
|
.br
|
|
.B int pcre_fullinfo(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
|
|
.ti +5n
|
|
.B int \fIwhat\fP, void *\fIwhere\fP);
|
|
.
|
|
.SH DESCRIPTION
|
|
.rs
|
|
.sp
|
|
This function returns information about a compiled pattern. Its arguments are:
|
|
.sp
|
|
\fIcode\fP Compiled regular expression
|
|
\fIextra\fP Result of \fBpcre_study()\fP or NULL
|
|
\fIwhat\fP What information is required
|
|
\fIwhere\fP Where to put the information
|
|
.sp
|
|
The following information is available:
|
|
.sp
|
|
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 Options used for compilation
|
|
PCRE_INFO_SIZE Size of compiled pattern
|
|
PCRE_INFO_STUDYSIZE Size of study data
|
|
.sp
|
|
The yield of the function is zero on success or:
|
|
.sp
|
|
PCRE_ERROR_NULL the argument \fIcode\fP was NULL
|
|
the argument \fIwhere\fP was NULL
|
|
PCRE_ERROR_BADMAGIC the "magic number" was not found
|
|
PCRE_ERROR_BADOPTION the value of \fIwhat\fP was invalid
|
|
.P
|
|
There is a complete description of the PCRE native API in the
|
|
.\" HREF
|
|
\fBpcreapi\fP
|
|
.\"
|
|
page and a description of the POSIX API in the
|
|
.\" HREF
|
|
\fBpcreposix\fP
|
|
.\"
|
|
page.
|