doc/pcre_study.3

   1 .TH PCRE_STUDY 3
   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);
  13 .
  14 .SH DESCRIPTION
  15 .rs
  16 .sp
  17 This function studies a compiled pattern, to see if additional information can
  18 be extracted that might speed up matching. Its arguments are:
  19 .sp
  20   \fIcode\fP       A compiled regular expression
  21   \fIoptions\fP    Options for \fBpcre_study()\fP
  22   \fIerrptr\fP     Where to put an error message
  23 .sp
  24 If the function succeeds, it returns a value that can be passed to
  25 \fBpcre_exec()\fP via its \fIextra\fP argument.
  26 .P
  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 looking at
  29 the error value. It is NULL in first case.
  30 .P
  31 There are currently no options defined; the value of the second argument should
  32 always be zero.
  33 .P
  34 There is a complete description of the PCRE native API in the
  35 .\" HREF
  36 \fBpcreapi\fP
  37 .\"
  38 page and a description of the POSIX API in the
  39 .\" HREF
  40 \fBpcreposix\fP
  41 .\"
  42 page.