/[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 75 - (hide annotations) (download)
Sat Feb 24 21:40:37 2007 UTC (7 years, 2 months ago) by nigel
File size: 1160 byte(s)
Load pcre-5.0 into code/trunk.

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 nigel 75 .B int pcre_get_substring_list(const char *\fIsubject\fP,
12 nigel 63 .ti +5n
13 nigel 75 .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
14     .
15 nigel 63 .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 nigel 75 .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 nigel 63 .\" HREF
34 nigel 75 \fBpcreapi\fP
35 nigel 63 .\"
36 nigel 75 page and a description of the POSIX API in the
37     .\" HREF
38     \fBpcreposix\fP
39     .\"
40 nigel 63 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12