/[pcre]/code/trunk/doc/pcre_get_substring_list.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_get_substring_list.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 79 - (show annotations) (download)
Sat Feb 24 21:40:52 2007 UTC (7 years, 2 months ago) by nigel
File size: 1179 byte(s)
Load pcre-6.1 into code/trunk.

1 .TH PCRE_GET_SUBSTRING_LIST 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.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12