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\fR,
.ti +5n
.B const char *\fIsubject\fR, int *\fIovector\fR,
.ti +5n
.B int \fIstringcount\fR, const char *\fIstringname\fR,
.ti +5n
.B const char **\fIstringptr\fR);

.SH DESCRIPTION
.rs
.sp
This is a convenience function for extracting a captured substring by name. The
arguments are:

  \fIcode\fR          Compiled pattern
  \fIsubject\fR       Subject that has been successfully matched
  \fIovector\fR       Offset vector that \fBpcre_exec()\fR used
  \fIstringcount\fR   Value returned by \fBpcre_exec()\fR
  \fIstringname\fR    Name of the required substring
  \fIstringptr\fR     Where to put the string pointer

The yield 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.

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