trunk/doc/pcre_get_stringnumber.3

.TH PCRE_GET_STRINGNUMBER 3
.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);
.
.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_get_stringnumber()\fP. You can obtain the complete list by calling
\fBpcre_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	nigel	79	.TH PCRE_GET_STRINGNUMBER 3
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			.
14	nigel	63	.SH DESCRIPTION
15			.rs
16			.sp
17			This convenience function finds the number of a named substring capturing
18			parenthesis in a compiled pattern. Its arguments are:
19	nigel	75	.sp
20			\fIcode\fP Compiled regular expression
21			\fIname\fP Name whose number is required
22			.sp
23	nigel	63	The yield of the function is the number of the parenthesis if the name is
24	nigel	93	found, or PCRE_ERROR_NOSUBSTRING otherwise. When duplicate names are allowed
25			(PCRE_DUPNAMES is set), it is not defined which of the numbers is returned by
26			\fBpcre_get_stringnumber()\fP. You can obtain the complete list by calling
27			\fBpcre_get_stringtable_entries()\fP.
28	nigel	75	.P
29			There is a complete description of the PCRE native API in the
30	nigel	63	.\" HREF
31	nigel	75	\fBpcreapi\fP
32	nigel	63	.\"
33	nigel	75	page and a description of the POSIX API in the
34			.\" HREF
35			\fBpcreposix\fP
36			.\"
37	nigel	63	page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"