trunk/doc/pcre_get_named_substring.3

.TH PCRE_GET_NAMED_SUBSTRING 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.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 convenience function \fBpcre_free_substring()\fP can
be used to free it when it is no longer needed. 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	.TH PCRE_GET_NAMED_SUBSTRING 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	.B int pcre_get_named_substring(const pcre *\fIcode\fP,
11	.ti +5n
12	.B const char \fIsubject\fP, int \fIovector\fP,
13	.ti +5n
14	.B int \fIstringcount\fP, const char *\fIstringname\fP,
15	.ti +5n
16	.B const char **\fIstringptr\fP);
17	.
18	.SH DESCRIPTION
19	.rs
20	.sp
21	This is a convenience function for extracting a captured substring by name. The
22	arguments are:
23	.sp
24	\fIcode\fP Compiled pattern
25	\fIsubject\fP Subject that has been successfully matched
26	\fIovector\fP Offset vector that \fBpcre_exec()\fP used
27	\fIstringcount\fP Value returned by \fBpcre_exec()\fP
28	\fIstringname\fP Name of the required substring
29	\fIstringptr\fP Where to put the string pointer
30	.sp
31	The memory in which the substring is placed is obtained by calling
32	\fBpcre_malloc()\fP. The convenience function \fBpcre_free_substring()\fP can
33	be used to free it when it is no longer needed. The yield of the function is
34	the length of the extracted substring, PCRE_ERROR_NOMEMORY if sufficient memory
35	could not be obtained, or 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	.\" HREF
39	\fBpcreapi\fP
40	.\"
41	page and a description of the POSIX API in the
42	.\" HREF
43	\fBpcreposix\fP
44	.\"
45	page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"