NAME | SYNOPSIS | DESCRIPTION | COLOPHON

PCRE_STUDY(3)             Library Functions Manual             PCRE_STUDY(3)

NAME         top

       PCRE - Perl-compatible regular expressions

SYNOPSIS         top


       #include <pcre.h>

       pcre_extra *pcre_study(const pcre *code, int options,
            const char **errptr);

       pcre16_extra *pcre16_study(const pcre16 *code, int options,
            const char **errptr);

       pcre32_extra *pcre32_study(const pcre32 *code, int options,
            const char **errptr);

DESCRIPTION         top


       This function studies a compiled pattern, to see if additional
       information can be extracted that might speed up matching. Its
       arguments are:

         code       A compiled regular expression
         options    Options for pcre[16|32]_study()
         errptr     Where to put an error message

       If the function succeeds, it returns a value that can be passed to
       pcre[16|32]_exec() or pcre[16|32]_dfa_exec() via their extra
       arguments.

       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.

       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 pcrejit page for further
       details.

       There is a complete description of the PCRE native API in the pcreapi
       page and a description of the POSIX API in the pcreposix page.

COLOPHON         top

       This page is part of the PCRE (Perl Compatible Regular Expressions)
       project.  Information about the project can be found at 
       ⟨http://www.pcre.org/⟩.  If you have a bug report for this manual
       page, see ⟨http://bugs.exim.org/enter_bug.cgi?product=PCRE⟩.  This
       page was obtained from the tarball pcre-8.40.tar.gz fetched from 
       ⟨ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/⟩ on
       2017-03-13.  If you discover any rendering problems in this HTML ver‐
       sion of the page, or you believe there is a better or more up-to-date
       source for the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original man‐
       ual page), send a mail to man-pages@man7.org

PCRE 8.30                        24 June 2012                  PCRE_STUDY(3)