trunk/doc/pcre_get_stringnumber.3

.TH PCRE_GET_STRINGNUMBER 3 "24 June 2012" "PCRE 8.30"
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.B int pcre_get_stringnumber(const pcre *\fIcode\fP,
.ti +5n
.B const char *\fIname\fP);
.PP
.B int pcre16_get_stringnumber(const pcre16 *\fIcode\fP,
.ti +5n
.B PCRE_SPTR16 \fIname\fP);
.PP
.B int pcre32_get_stringnumber(const pcre32 *\fIcode\fP,
.ti +5n
.B PCRE_SPTR32 \fIname\fP);
.
.SH DESCRIPTION
.rs
.sp
This convenience function finds the number of a named substring capturing
parenthesis in a compiled pattern. Its arguments are:
.sp
  \fIcode\fP    Compiled regular expression
  \fIname\fP    Name whose number is required
.sp
The yield of the function is the number of the parenthesis if the name is
found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
(PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
\fBpcre[16|32]_get_stringnumber()\fP. You can obtain the complete list by calling
\fBpcre[16|32]_get_stringtable_entries()\fP.
.P
There is a complete description of the PCRE native API in the
.\" HREF
\fBpcreapi\fP
.\"
page and a description of the POSIX API in the
.\" HREF
\fBpcreposix\fP
.\"
page.
1	chpe	1055	.TH PCRE_GET_STRINGNUMBER 3 "24 June 2012" "PCRE 8.30"
2	nigel	63	.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	nigel	75	.B int pcre_get_stringnumber(const pcre *\fIcode\fP,
11	nigel	63	.ti +5n
12	nigel	75	.B const char *\fIname\fP);
13	ph10	868	.PP
14			.B int pcre16_get_stringnumber(const pcre16 *\fIcode\fP,
15			.ti +5n
16			.B PCRE_SPTR16 \fIname\fP);
17	chpe	1055	.PP
18			.B int pcre32_get_stringnumber(const pcre32 *\fIcode\fP,
19			.ti +5n
20			.B PCRE_SPTR32 \fIname\fP);
21	nigel	75	.
22	nigel	63	.SH DESCRIPTION
23			.rs
24			.sp
25			This convenience function finds the number of a named substring capturing
26			parenthesis in a compiled pattern. Its arguments are:
27	nigel	75	.sp
28			\fIcode\fP Compiled regular expression
29			\fIname\fP Name whose number is required
30			.sp
31	nigel	63	The yield of the function is the number of the parenthesis if the name is
32	nigel	93	found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
33			(PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
34	chpe	1055	\fBpcre[16\|32]_get_stringnumber()\fP. You can obtain the complete list by calling
35			\fBpcre[16\|32]_get_stringtable_entries()\fP.
36	nigel	75	.P
37			There is a complete description of the PCRE native API in the
38	nigel	63	.\" HREF
39	nigel	75	\fBpcreapi\fP
40	nigel	63	.\"
41	nigel	75	page and a description of the POSIX API in the
42			.\" HREF
43			\fBpcreposix\fP
44			.\"
45	nigel	63	page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"