/[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 1055 - (show annotations)
Tue Oct 16 15:53:30 2012 UTC (7 years ago) by chpe
File size: 1640 byte(s)
pcre32: Add 32-bit library

Create libpcre32 that operates on 32-bit characters (UTF-32).

This turned out to be surprisingly simple after the UTF-16 support
was introduced; mostly just extra ifdefs and adjusting and adding
some tests.
1 .TH PCRE_GET_SUBSTRING_LIST 3 "24 June 2012" "PCRE 8.30"
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 .B int pcre_get_substring_list(const char *\fIsubject\fP,
11 .ti +5n
12 .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
13 .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 .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 .
22 .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 .sp
28 \fIsubject\fP Subject that has been successfully matched
29 \fIovector\fP Offset vector that \fBpcre[16|32]_exec\fP used
30 \fIstringcount\fP Value returned by \fBpcre[16|32]_exec\fP
31 \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 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 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 .P
41 There is a complete description of the PCRE native API in the
42 .\" HREF
43 \fBpcreapi\fP
44 .\"
45 page and a description of the POSIX API in the
46 .\" HREF
47 \fBpcreposix\fP
48 .\"
49 page.

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5