Return to pcre_get_stringtable_entries.3 CVS log

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

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

1.1.1.4 ! misho       1: .TH PCRE_GET_STRINGTABLE_ENTRIES 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 int pcre_get_stringtable_entries(const pcre *\fIcode\fP,
                     11: .ti +5n
                     12: .B const char *\fIname\fP, char **\fIfirst\fP, char **\fIlast\fP);
1.1.1.2   misho      13: .PP
                     14: .B int pcre16_get_stringtable_entries(const pcre16 *\fIcode\fP,
                     15: .ti +5n
                     16: .B PCRE_SPTR16 \fIname\fP, PCRE_UCHAR16 **\fIfirst\fP, PCRE_UCHAR16 **\fIlast\fP);
1.1.1.4 ! misho      17: .PP
        !            18: .B int pcre32_get_stringtable_entries(const pcre32 *\fIcode\fP,
        !            19: .ti +5n
        !            20: .B PCRE_SPTR32 \fIname\fP, PCRE_UCHAR32 **\fIfirst\fP, PCRE_UCHAR32 **\fIlast\fP);
1.1       misho      21: .
                     22: .SH DESCRIPTION
                     23: .rs
                     24: .sp
                     25: This convenience function finds, for a compiled pattern, the first and last
                     26: entries for a given name in the table that translates capturing parenthesis
                     27: names into numbers. When names are required to be unique (PCRE_DUPNAMES is
1.1.1.4 ! misho      28: \fInot\fP set), it is usually easier to use \fBpcre[16|32]_get_stringnumber()\fP
1.1       misho      29: instead.
                     30: .sp
                     31:   \fIcode\fP    Compiled regular expression
                     32:   \fIname\fP    Name whose entries required
                     33:   \fIfirst\fP   Where to return a pointer to the first entry
                     34:   \fIlast\fP    Where to return a pointer to the last entry
                     35: .sp
                     36: The yield of the function is the length of each entry, or
                     37: PCRE_ERROR_NOSUBSTRING if none are found.
                     38: .P
                     39: There is a complete description of the PCRE native API, including the format of
                     40: the table entries, in the
                     41: .\" HREF
                     42: \fBpcreapi\fP
                     43: .\"
                     44: page, and a description of the POSIX API in the
                     45: .\" HREF
                     46: \fBpcreposix\fP
                     47: .\"
                     48: page.