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

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