| <html> |
| <head> |
| <title>pcre_study specification</title> |
| </head> |
| <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> |
| <h1>pcre_study 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>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i>,</b> |
| <b>const char **<i>errptr</i>);</b> |
| </P> |
| <br><b> |
| DESCRIPTION |
| </b><br> |
| <P> |
| This function studies a compiled pattern, to see if additional information can |
| be extracted that might speed up matching. Its arguments are: |
| <pre> |
| <i>code</i> A compiled regular expression |
| <i>options</i> Options for <b>pcre_study()</b> |
| <i>errptr</i> Where to put an error message |
| </pre> |
| If the function succeeds, it returns a value that can be passed to |
| <b>pcre_exec()</b> or <b>pcre_dfa_exec()</b> via their <i>extra</i> arguments. |
| </P> |
| <P> |
| If the function returns NULL, either it could not find any additional |
| information, or there was an error. You can tell the difference by looking at |
| the error value. It is NULL in first case. |
| </P> |
| <P> |
| The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation |
| if possible. If PCRE has been compiled without JIT support, this option is |
| ignored. See the |
| <a href="pcrejit.html"><b>pcrejit</b></a> |
| page for further details. |
| </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> |