/vendor/pcre/doc/pcre_fullinfo.3

 1.TH PCRE_FULLINFO 3
 2.SH NAME
 3PCRE - Perl-compatible regular expressions
 4.SH SYNOPSIS
 5.rs
 6.sp
 7.B #include <pcre.h>
 8.PP
 9.SM
10.B int pcre_fullinfo(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
11.ti +5n
12.B int \fIwhat\fP, void *\fIwhere\fP);
13.
14.SH DESCRIPTION
15.rs
16.sp
17This function returns information about a compiled pattern. Its arguments are:
18.sp
19  \fIcode\fP                      Compiled regular expression
20  \fIextra\fP                     Result of \fBpcre_study()\fP or NULL
21  \fIwhat\fP                      What information is required
22  \fIwhere\fP                     Where to put the information
23.sp
24The following information is available:
25.sp
26  PCRE_INFO_BACKREFMAX      Number of highest back reference
27  PCRE_INFO_CAPTURECOUNT    Number of capturing subpatterns
28  PCRE_INFO_DEFAULT_TABLES  Pointer to default tables
29  PCRE_INFO_FIRSTBYTE       Fixed first byte for a match, or
30                              -1 for start of string
31                                 or after newline, or
32                              -2 otherwise
33  PCRE_INFO_FIRSTTABLE      Table of first bytes (after studying)
34  PCRE_INFO_JCHANGED        Return 1 if (?J) or (?-J) was used
35  PCRE_INFO_LASTLITERAL     Literal last byte required
36  PCRE_INFO_NAMECOUNT       Number of named subpatterns
37  PCRE_INFO_NAMEENTRYSIZE   Size of name table entry
38  PCRE_INFO_NAMETABLE       Pointer to name table
39  PCRE_INFO_OKPARTIAL       Return 1 if partial matching can be tried
40  PCRE_INFO_OPTIONS         Option bits used for compilation
41  PCRE_INFO_SIZE            Size of compiled pattern
42  PCRE_INFO_STUDYSIZE       Size of study data
43.sp
44The yield of the function is zero on success or:
45.sp
46  PCRE_ERROR_NULL           the argument \fIcode\fP was NULL
47                            the argument \fIwhere\fP was NULL
48  PCRE_ERROR_BADMAGIC       the "magic number" was not found
49  PCRE_ERROR_BADOPTION      the value of \fIwhat\fP was invalid
50.P
51There is a complete description of the PCRE native API in the
52.\" HREF
53\fBpcreapi\fP
54.\"
55page and a description of the POSIX API in the
56.\" HREF
57\fBpcreposix\fP
58.\"
59page.