Annotation of embedaddon/pcre/doc/pcre_get_stringtable_entries.3, revision 1.1.1.2
1.1 misho 1: .TH PCRE_GET_STRINGTABLE_ENTRIES 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 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 misho 17: .
18: .SH DESCRIPTION
19: .rs
20: .sp
21: This convenience function finds, for a compiled pattern, the first and last
22: entries for a given name in the table that translates capturing parenthesis
23: names into numbers. When names are required to be unique (PCRE_DUPNAMES is
1.1.1.2 ! misho 24: \fInot\fP set), it is usually easier to use \fBpcre[16]_get_stringnumber()\fP
1.1 misho 25: instead.
26: .sp
27: \fIcode\fP Compiled regular expression
28: \fIname\fP Name whose entries required
29: \fIfirst\fP Where to return a pointer to the first entry
30: \fIlast\fP Where to return a pointer to the last entry
31: .sp
32: The yield of the function is the length of each entry, or
33: PCRE_ERROR_NOSUBSTRING if none are found.
34: .P
35: There is a complete description of the PCRE native API, including the format of
36: the table entries, in the
37: .\" HREF
38: \fBpcreapi\fP
39: .\"
40: page, and a description of the POSIX API in the
41: .\" HREF
42: \fBpcreposix\fP
43: .\"
44: page.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>