/[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 96 - (hide annotations) (download)
Fri Mar 2 13:10:43 2007 UTC (7 years, 4 months ago) by nigel
File size: 1289 byte(s)
 r6896@hex:  nm | 2007-03-02 13:09:14 +0000
 Added EOL and keywork properties throughout

1 nigel 79 .TH PCRE_GET_SUBSTRING_LIST 3
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     .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 nigel 93 calling \fBpcre_malloc()\fP. The convenience function
28     \fBpcre_free_substring_list()\fP can be used to free it when it is no longer
29     needed. A pointer to a list of pointers is put in the variable whose address is
30     in \fIlistptr\fP. The list is terminated by a NULL pointer. The yield of the
31     function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
32     not be obtained.
33 nigel 75 .P
34     There is a complete description of the PCRE native API in the
35 nigel 63 .\" HREF
36 nigel 75 \fBpcreapi\fP
37 nigel 63 .\"
38 nigel 75 page and a description of the POSIX API in the
39     .\" HREF
40     \fBpcreposix\fP
41     .\"
42 nigel 63 page.

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12