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.3

1.1.1.3 ! misho       1: .TH PCRE_STUDY 3 "13 January 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       misho      17: .
                     18: .SH DESCRIPTION
                     19: .rs
                     20: .sp
                     21: This function studies a compiled pattern, to see if additional information can
                     22: be extracted that might speed up matching. Its arguments are:
                     23: .sp
                     24:   \fIcode\fP       A compiled regular expression
1.1.1.2   misho      25:   \fIoptions\fP    Options for \fBpcre[16]_study()\fP
1.1       misho      26:   \fIerrptr\fP     Where to put an error message
                     27: .sp
                     28: If the function succeeds, it returns a value that can be passed to
1.1.1.2   misho      29: \fBpcre[16]_exec()\fP or \fBpcre[16]_dfa_exec()\fP via their \fIextra\fP
                     30: arguments.
1.1       misho      31: .P
                     32: If the function returns NULL, either it could not find any additional
                     33: information, or there was an error. You can tell the difference by looking at
                     34: the error value. It is NULL in first case.
                     35: .P
                     36: The only option is PCRE_STUDY_JIT_COMPILE. It requests just-in-time compilation
                     37: if possible. If PCRE has been compiled without JIT support, this option is
                     38: ignored. See the
                     39: .\" HREF
                     40: \fBpcrejit\fP
                     41: .\"
                     42: page for further details.
                     43: .P
                     44: There is a complete description of the PCRE native API in the
                     45: .\" HREF
                     46: \fBpcreapi\fP
                     47: .\"
                     48: page and a description of the POSIX API in the
                     49: .\" HREF
                     50: \fBpcreposix\fP
                     51: .\"
                     52: page.