| .TH PCRE_FULLINFO 3 |
| .SH NAME |
| PCRE - Perl-compatible regular expressions |
| .SH SYNOPSIS |
| .rs |
| .sp |
| .B #include <pcre.h> |
| .PP |
| .SM |
| .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_HASCRORLF Return 1 if explicit CR or LF matches exist |
| PCRE_INFO_JCHANGED Return 1 if (?J) or (?-J) was used |
| PCRE_INFO_JIT Return 1 after successful JIT compilation |
| PCRE_INFO_LASTLITERAL Literal last byte required |
| PCRE_INFO_MINLENGTH Lower bound length of matching strings |
| PCRE_INFO_NAMECOUNT Number of named subpatterns |
| PCRE_INFO_NAMEENTRYSIZE Size of name table entry |
| PCRE_INFO_NAMETABLE Pointer to name table |
| PCRE_INFO_OKPARTIAL Return 1 if partial matching can be tried |
| (always returns 1 after release 8.00) |
| PCRE_INFO_OPTIONS Option bits used for compilation |
| PCRE_INFO_SIZE Size of compiled pattern |
| PCRE_INFO_STUDYSIZE Size of study data |
| .sp |
| The \fIwhere\fP argument must point to an integer variable, except for the |
| following \fIwhat\fP values: |
| .sp |
| PCRE_INFO_DEFAULT_TABLES const unsigned char * |
| PCRE_INFO_FIRSTTABLE const unsigned char * |
| PCRE_INFO_NAMETABLE const unsigned char * |
| PCRE_INFO_OPTIONS unsigned long int |
| PCRE_INFO_SIZE size_t |
| .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. |