trunk/doc/pcre_get_substring_list.3

.TH PCRE_GET_SUBSTRING_LIST 3 "24 June 2012" "PCRE 8.30"
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.B int pcre_get_substring_list(const char *\fIsubject\fP,
.ti +5n
.B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
.PP
.B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP,
.ti +5n
.B int *\fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR16 **\fIlistptr\fP);"
.PP
.B int pcre32_get_substring_list(PCRE_SPTR32 \fIsubject\fP,
.ti +5n
.B int *\fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR32 **\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[16|32]_exec\fP used
  \fIstringcount\fP   Value returned by \fBpcre[16|32]_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[16|32]_malloc()\fP. The convenience function
\fBpcre[16|32]_free_substring_list()\fP can be used to free it when it is no
longer needed. 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	chpe	1055	.TH PCRE_GET_SUBSTRING_LIST 3 "24 June 2012" "PCRE 8.30"
2	nigel	63	.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	nigel	75	.B int pcre_get_substring_list(const char *\fIsubject\fP,
11	nigel	63	.ti +5n
12	nigel	75	.B int \fIovector\fP, int \fIstringcount\fP, "const char **\fIlistptr\fP);"
13	ph10	868	.PP
14			.B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP,
15			.ti +5n
16			.B int \fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR16 *\fIlistptr\fP);"
17	chpe	1055	.PP
18			.B int pcre32_get_substring_list(PCRE_SPTR32 \fIsubject\fP,
19			.ti +5n
20			.B int \fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR32 *\fIlistptr\fP);"
21	nigel	75	.
22	nigel	63	.SH DESCRIPTION
23			.rs
24			.sp
25			This is a convenience function for extracting a list of all the captured
26			substrings. The arguments are:
27	nigel	75	.sp
28			\fIsubject\fP Subject that has been successfully matched
29	chpe	1055	\fIovector\fP Offset vector that \fBpcre[16\|32]_exec\fP used
30			\fIstringcount\fP Value returned by \fBpcre[16\|32]_exec\fP
31	nigel	75	\fIlistptr\fP Where to put a pointer to the list
32			.sp
33			The memory in which the substrings and the list are placed is obtained by
34	chpe	1055	calling \fBpcre[16\|32]_malloc()\fP. The convenience function
35			\fBpcre[16\|32]_free_substring_list()\fP can be used to free it when it is no
36	ph10	868	longer needed. A pointer to a list of pointers is put in the variable whose
37			address is in \fIlistptr\fP. The list is terminated by a NULL pointer. The
38			yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient
39			memory could not be obtained.
40	nigel	75	.P
41			There is a complete description of the PCRE native API in the
42	nigel	63	.\" HREF
43	nigel	75	\fBpcreapi\fP
44	nigel	63	.\"
45	nigel	75	page and a description of the POSIX API in the
46			.\" HREF
47			\fBpcreposix\fP
48			.\"
49	nigel	63	page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"