/[pcre]/code/trunk/doc/pcre_fullinfo.3
ViewVC logotype

Diff of /code/trunk/doc/pcre_fullinfo.3

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 63 by nigel, Sat Feb 24 21:40:03 2007 UTC revision 75 by nigel, Sat Feb 24 21:40:37 2007 UTC
# Line 8  PCRE - Perl-compatible regular expressio Line 8  PCRE - Perl-compatible regular expressio
8  .PP  .PP
9  .SM  .SM
10  .br  .br
11  .B int pcre_fullinfo(const pcre *\fIcode\fR, "const pcre_extra *\fIextra\fR,"  .B int pcre_fullinfo(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
12  .ti +5n  .ti +5n
13  .B int \fIwhat\fR, void *\fIwhere\fR);  .B int \fIwhat\fP, void *\fIwhere\fP);
14    .
15  .SH DESCRIPTION  .SH DESCRIPTION
16  .rs  .rs
17  .sp  .sp
18  This function returns information about a compiled pattern. Its arguments are:  This function returns information about a compiled pattern. Its arguments are:
19    .sp
20    \fIcode\fR    Compiled regular expression    \fIcode\fP                      Compiled regular expression
21    \fIextra\fR   Result of \fBpcre_study()\fR or NULL    \fIextra\fP                     Result of \fBpcre_study()\fP or NULL
22    \fIwhat\fR    What information is required    \fIwhat\fP                      What information is required
23    \fIwhere\fR   Where to put the information    \fIwhere\fP                     Where to put the information
24    .sp
25  The following information is available:  The following information is available:
26    .sp
27    PCRE_INFO_BACKREFMAX     Number of highest back reference    PCRE_INFO_BACKREFMAX      Number of highest back reference
28    PCRE_INFO_CAPTURECOUNT   Number of capturing subpatterns    PCRE_INFO_CAPTURECOUNT    Number of capturing subpatterns
29    PCRE_INFO_FIRSTBYTE      Fixed first byte for a match, or    PCRE_INFO_DEFAULT_TABLES  Pointer to default tables
30                               -1 for start of string    PCRE_INFO_FIRSTBYTE       Fixed first byte for a match, or
31                                  or after newline, or                                -1 for start of string
32                               -2 otherwise                                   or after newline, or
33    PCRE_INFO_FIRSTTABLE     Table of first bytes                                -2 otherwise
34                               (after studying)    PCRE_INFO_FIRSTTABLE      Table of first bytes
35    PCRE_INFO_LASTLITERAL    Literal last byte required                                (after studying)
36    PCRE_INFO_NAMECOUNT      Number of named subpatterns    PCRE_INFO_LASTLITERAL     Literal last byte required
37    PCRE_INFO_NAMEENTRYSIZE  Size of name table entry    PCRE_INFO_NAMECOUNT       Number of named subpatterns
38    PCRE_INFO_NAMETABLE      Pointer to name table    PCRE_INFO_NAMEENTRYSIZE   Size of name table entry
39    PCRE_INFO_OPTIONS        Options used for compilation    PCRE_INFO_NAMETABLE       Pointer to name table
40    PCRE_INFO_SIZE           Size of compiled pattern    PCRE_INFO_OPTIONS         Options used for compilation
41      PCRE_INFO_SIZE            Size of compiled pattern
42      PCRE_INFO_STUDYSIZE       Size of study data
43    .sp
44  The yield of the function is zero on success or:  The yield of the function is zero on success or:
45    .sp
46    PCRE_ERROR_NULL       the argument \fIcode\fR was NULL    PCRE_ERROR_NULL           the argument \fIcode\fP was NULL
47                          the argument \fIwhere\fR was NULL                              the argument \fIwhere\fP was NULL
48    PCRE_ERROR_BADMAGIC   the "magic number" was not found    PCRE_ERROR_BADMAGIC       the "magic number" was not found
49    PCRE_ERROR_BADOPTION  the value of \fIwhat\fR was invalid    PCRE_ERROR_BADOPTION      the value of \fIwhat\fP was invalid
50    .P
51  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
52    .\" HREF
53    \fBpcreapi\fP
54    .\"
55    page and a description of the POSIX API in the
56  .\" HREF  .\" HREF
57  \fBpcreapi\fR  \fBpcreposix\fP
58  .\"  .\"
59  page.  page.
Legend:
Removed from v.63  
changed lines
  Added in v.75
  ViewVC Help
Powered by ViewVC 1.1.5