trunk/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\fR,
.ti +5n
.B int *\fIovector\fR, int \fIstringcount\fR, "const char ***\fIlistptr\fR);"

.SH DESCRIPTION
.rs
.sp
This is a convenience function for extracting a list of all the captured
substrings. The arguments are:

  \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
  \fIlistptr\fR       Where to put a pointer to the list

The yield is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
not be obtained.

There is a complete description of the PCRE API in the
.\" HREF
\fBpcreapi\fR
.\"
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			.B int pcre_get_substring_list(const char *\fIsubject\fR,
12			.ti +5n
13			.B int \fIovector\fR, int \fIstringcount\fR, "const char **\fIlistptr\fR);"
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
21			\fIsubject\fR Subject that has been successfully matched
22			\fIovector\fR Offset vector that \fBpcre_exec\fR used
23			\fIstringcount\fR Value returned by \fBpcre_exec\fR
24			\fIlistptr\fR Where to put a pointer to the list
25
26			The yield is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
27			not be obtained.
28
29			There is a complete description of the PCRE API in the
30			.\" HREF
31			\fBpcreapi\fR
32			.\"
33			page.