pcre-5.0/doc/pcre_get_substring_list.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_substring_list(const char *\fIsubject\fP,
.ti +5n
.B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
.
.SH DESCRIPTION
.rs
.sp
This is a convenience function for extracting a list of all the captured
substrings. The arguments are:
.sp
  \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
  \fIlistptr\fP       Where to put a pointer to the list
.sp
The memory in which the substrings and the list are placed is obtained by
calling \fBpcre_malloc()\fP. A pointer to a list of pointers is put in
the variable whose address is in \fIlistptr\fP. The list is terminated by a
NULL pointer. The yield of the function is zero on success or
PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained.
.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_substring_list(const char *\fIsubject\fP,
12	.ti +5n
13	.B int \fIovector\fP, int \fIstringcount\fP, "const char **\fIlistptr\fP);"
14	.
15	.SH DESCRIPTION
16	.rs
17	.sp
18	This is a convenience function for extracting a list of all the captured
19	substrings. The arguments are:
20	.sp
21	\fIsubject\fP Subject that has been successfully matched
22	\fIovector\fP Offset vector that \fBpcre_exec\fP used
23	\fIstringcount\fP Value returned by \fBpcre_exec\fP
24	\fIlistptr\fP Where to put a pointer to the list
25	.sp
26	The memory in which the substrings and the list are placed is obtained by
27	calling \fBpcre_malloc()\fP. A pointer to a list of pointers is put in
28	the variable whose address is in \fIlistptr\fP. The list is terminated by a
29	NULL pointer. The yield of the function is zero on success or
30	PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained.
31	.P
32	There is a complete description of the PCRE native API in the
33	.\" HREF
34	\fBpcreapi\fP
35	.\"
36	page and a description of the POSIX API in the
37	.\" HREF
38	\fBpcreposix\fP
39	.\"
40	page.