1PCRE_STUDY(3)              Library Functions Manual              PCRE_STUDY(3)
2
3
4

NAME

6       PCRE - Perl-compatible regular expressions
7

SYNOPSIS

9
10       #include <pcre.h>
11
12       pcre_extra *pcre_study(const pcre *code, int options,
13            const char **errptr);
14

DESCRIPTION

16
17       This function studies a compiled pattern, to see if additional informa‐
18       tion can be extracted that might speed up matching. Its arguments are:
19
20         code       A compiled regular expression
21         options    Options for pcre_study()
22         errptr     Where to put an error message
23
24       If the function succeeds, it returns a value  that  can  be  passed  to
25       pcre_exec() via its extra argument.
26
27       If  the  function returns NULL, either it could not find any additional
28       information, or there was an error. You  can  tell  the  difference  by
29       looking at the error value. It is NULL in first case.
30
31       There  are  currently no options defined; the value of the second argu‐
32       ment should always be zero.
33
34       There is a complete description of the PCRE native API in  the  pcreapi
35       page and a description of the POSIX API in the pcreposix page.
36
37
38
39                                                                 PCRE_STUDY(3)