trunk/doc/pcre_get_stringnumber.3

.TH PCRE 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.br
.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.
.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	.TH PCRE 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	.br
11	.B int pcre_get_stringnumber(const pcre *\fIcode\fP,
12	.ti +5n
13	.B const char *\fIname\fP);
14	.
15	.SH DESCRIPTION
16	.rs
17	.sp
18	This convenience function finds the number of a named substring capturing
19	parenthesis in a compiled pattern. Its arguments are:
20	.sp
21	\fIcode\fP Compiled regular expression
22	\fIname\fP Name whose number is required
23	.sp
24	The yield of the function is the number of the parenthesis if the name is
25	found, or PCRE_ERROR_NOSUBSTRING otherwise.
26	.P
27	There is a complete description of the PCRE native API in the
28	.\" HREF
29	\fBpcreapi\fP
30	.\"
31	page and a description of the POSIX API in the
32	.\" HREF
33	\fBpcreposix\fP
34	.\"
35	page.