trunk/doc/pcre_get_stringtable_entries.3

.TH PCRE_GET_STRINGTABLE_ENTRIES 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.br
.B int pcre_get_stringtable_entries(const pcre *\fIcode\fP,
.ti +5n
.B const char *\fIname\fP, char **\fIfirst\fP, char **\fIlast\fP);
.
.SH DESCRIPTION
.rs
.sp
This convenience function finds, for a compiled pattern, the first and last
entries for a given name in the table that translates capturing parenthesis
names into numbers. When names are required to be unique (PCRE_DUPNAMES is
\fInot\fP set), it is usually easier to use \fBpcre_get_stringnumber()\fP
instead.
.sp
  \fIcode\fP    Compiled regular expression
  \fIname\fP    Name whose entries required
  \fIfirst\fP   Where to return a pointer to the first entry
  \fIlast\fP    Where to return a pointer to the last entry
.sp
The yield of the function is the length of each entry, or
PCRE_ERROR_NOSUBSTRING if none are found.
.P
There is a complete description of the PCRE native API, including the format of
the table entries, in the
.\" HREF
\fBpcreapi\fP
.\"
page, and a description of the POSIX API in the
.\" HREF
\fBpcreposix\fP
.\"
page.
1	nigel	93	.TH PCRE_GET_STRINGTABLE_ENTRIES 3
2	nigel	91	.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			.br
11			.B int pcre_get_stringtable_entries(const pcre *\fIcode\fP,
12			.ti +5n
13			.B const char \fIname\fP, char \fIfirst\fP, char *\fIlast\fP);
14			.
15			.SH DESCRIPTION
16			.rs
17			.sp
18			This convenience function finds, for a compiled pattern, the first and last
19			entries for a given name in the table that translates capturing parenthesis
20			names into numbers. When names are required to be unique (PCRE_DUPNAMES is
21			\fInot\fP set), it is usually easier to use \fBpcre_get_stringnumber()\fP
22			instead.
23			.sp
24			\fIcode\fP Compiled regular expression
25			\fIname\fP Name whose entries required
26			\fIfirst\fP Where to return a pointer to the first entry
27			\fIlast\fP Where to return a pointer to the last entry
28			.sp
29			The yield of the function is the length of each entry, or
30			PCRE_ERROR_NOSUBSTRING if none are found.
31			.P
32			There is a complete description of the PCRE native API, including the format of
33			the table entries, in the
34			.\" HREF
35			\fBpcreapi\fP
36			.\"
37	nigel	93	page, and a description of the POSIX API in the
38	nigel	91	.\" HREF
39			\fBpcreposix\fP
40			.\"
41			page.