| <html> |
| <head> |
| <title>pcre_fullinfo specification</title> |
| </head> |
| <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> |
| <h1>pcre_fullinfo man page</h1> |
| <p> |
| Return to the <a href="index.html">PCRE index page</a>. |
| </p> |
| <p> |
| This page is part of the PCRE HTML documentation. It was generated automatically |
| from the original man page. If there is any nonsense in it, please consult the |
| man page, in case the conversion went wrong. |
| <br> |
| <br><b> |
| SYNOPSIS |
| </b><br> |
| <P> |
| <b>#include <pcre.h></b> |
| </P> |
| <P> |
| <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b> |
| <b>int <i>what</i>, void *<i>where</i>);</b> |
| </P> |
| <br><b> |
| DESCRIPTION |
| </b><br> |
| <P> |
| This function returns information about a compiled pattern. Its arguments are: |
| <pre> |
| <i>code</i> Compiled regular expression |
| <i>extra</i> Result of <b>pcre_study()</b> or NULL |
| <i>what</i> What information is required |
| <i>where</i> Where to put the information |
| </pre> |
| The following information is available: |
| <pre> |
| 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 |
| </pre> |
| The <i>where</i> argument must point to an integer variable, except for the |
| following <i>what</i> values: |
| <pre> |
| 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 |
| </pre> |
| The yield of the function is zero on success or: |
| <pre> |
| PCRE_ERROR_NULL the argument <i>code</i> was NULL |
| the argument <i>where</i> was NULL |
| PCRE_ERROR_BADMAGIC the "magic number" was not found |
| PCRE_ERROR_BADOPTION the value of <i>what</i> was invalid |
| </PRE> |
| </P> |
| <P> |
| There is a complete description of the PCRE native API in the |
| <a href="pcreapi.html"><b>pcreapi</b></a> |
| page and a description of the POSIX API in the |
| <a href="pcreposix.html"><b>pcreposix</b></a> |
| page. |
| <p> |
| Return to the <a href="index.html">PCRE index page</a>. |
| </p> |