trunk/doc/pcre_get_named_substring.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_named_substring(const pcre *\fIcode\fP,
.ti +5n
.B const char *\fIsubject\fP, int *\fIovector\fP,
.ti +5n
.B int \fIstringcount\fP, const char *\fIstringname\fP,
.ti +5n
.B const char **\fIstringptr\fP);
.
.SH DESCRIPTION
.rs
.sp
This is a convenience function for extracting a captured substring by name. The
arguments are:
.sp
  \fIcode\fP          Compiled pattern
  \fIsubject\fP       Subject that has been successfully matched
  \fIovector\fP       Offset vector that \fBpcre_exec()\fP used
  \fIstringcount\fP   Value returned by \fBpcre_exec()\fP
  \fIstringname\fP    Name of the required substring
  \fIstringptr\fP     Where to put the string pointer
.sp
The memory in which the substring is placed is obtained by calling
\fBpcre_malloc()\fP. The yield of the function is the length of the extracted
substring, PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
PCRE_ERROR_NOSUBSTRING if the string name is invalid.
.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	63	.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	nigel	75	.B int pcre_get_named_substring(const pcre *\fIcode\fP,
12	nigel	63	.ti +5n
13	nigel	75	.B const char \fIsubject\fP, int \fIovector\fP,
14	nigel	63	.ti +5n
15	nigel	75	.B int \fIstringcount\fP, const char *\fIstringname\fP,
16	nigel	63	.ti +5n
17	nigel	75	.B const char **\fIstringptr\fP);
18			.
19	nigel	63	.SH DESCRIPTION
20			.rs
21			.sp
22			This is a convenience function for extracting a captured substring by name. The
23			arguments are:
24	nigel	75	.sp
25			\fIcode\fP Compiled pattern
26			\fIsubject\fP Subject that has been successfully matched
27			\fIovector\fP Offset vector that \fBpcre_exec()\fP used
28			\fIstringcount\fP Value returned by \fBpcre_exec()\fP
29			\fIstringname\fP Name of the required substring
30			\fIstringptr\fP Where to put the string pointer
31			.sp
32			The memory in which the substring is placed is obtained by calling
33			\fBpcre_malloc()\fP. The yield of the function is the length of the extracted
34			substring, PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
35			PCRE_ERROR_NOSUBSTRING if the string name is invalid.
36			.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.