Return to pcre_study.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Annotation of embedaddon/pcre/doc/pcre_study.3, revision 1.1.1.4

1.1.1.4 ! misho       1: .TH PCRE_STUDY 3 " 24 June 2012" "PCRE 8.30"
1.1       misho       2: .SH NAME
                      3: PCRE - Perl-compatible regular expressions
                      4: .SH SYNOPSIS
                      5: .rs
                      6: .sp
                      7: .B #include <pcre.h>
                      8: .PP
                      9: .SM
                     10: .B pcre_extra *pcre_study(const pcre *\fIcode\fP, int \fIoptions\fP,
                     11: .ti +5n
                     12: .B const char **\fIerrptr\fP);
1.1.1.2   misho      13: .PP
                     14: .B pcre16_extra *pcre16_study(const pcre16 *\fIcode\fP, int \fIoptions\fP,
                     15: .ti +5n
                     16: .B const char **\fIerrptr\fP);
1.1.1.4 ! misho      17: .PP
        !            18: .B pcre32_extra *pcre32_study(const pcre32 *\fIcode\fP, int \fIoptions\fP,
        !            19: .ti +5n
        !            20: .B const char **\fIerrptr\fP);
1.1       misho      21: .
                     22: .SH DESCRIPTION
                     23: .rs
                     24: .sp
                     25: This function studies a compiled pattern, to see if additional information can
                     26: be extracted that might speed up matching. Its arguments are:
                     27: .sp
                     28:   \fIcode\fP       A compiled regular expression
1.1.1.4 ! misho      29:   \fIoptions\fP    Options for \fBpcre[16|32]_study()\fP
1.1       misho      30:   \fIerrptr\fP     Where to put an error message
                     31: .sp
                     32: If the function succeeds, it returns a value that can be passed to
1.1.1.4 ! misho      33: \fBpcre[16|32]_exec()\fP or \fBpcre[16|32]_dfa_exec()\fP via their \fIextra\fP
1.1.1.2   misho      34: arguments.
1.1       misho      35: .P
                     36: If the function returns NULL, either it could not find any additional
                     37: information, or there was an error. You can tell the difference by looking at
                     38: the error value. It is NULL in first case.
                     39: .P
                     40: The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
                     41: if possible. If PCRE has been compiled without JIT support, this option is
                     42: ignored. See the
                     43: .\" HREF
                     44: \fBpcrejit\fP
                     45: .\"
                     46: page for further details.
                     47: .P
                     48: There is a complete description of the PCRE native API in the
                     49: .\" HREF
                     50: \fBpcreapi\fP
                     51: .\"
                     52: page and a description of the POSIX API in the
                     53: .\" HREF
                     54: \fBpcreposix\fP
                     55: .\"
                     56: page.