/vendor/pcre/doc/pcre_get_substring_list.3

 1.TH PCRE_GET_SUBSTRING_LIST 3
 2.SH NAME
 3PCRE - 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.
14.SH DESCRIPTION
15.rs
16.sp
17This is a convenience function for extracting a list of all the captured
18substrings. The arguments are:
19.sp
20  \fIsubject\fP       Subject that has been successfully matched
21  \fIovector\fP       Offset vector that \fBpcre_exec\fP used
22  \fIstringcount\fP   Value returned by \fBpcre_exec\fP
23  \fIlistptr\fP       Where to put a pointer to the list
24.sp
25The memory in which the substrings and the list are placed is obtained by
26calling \fBpcre_malloc()\fP. The convenience function
27\fBpcre_free_substring_list()\fP can be used to free it when it is no longer
28needed. A pointer to a list of pointers is put in the variable whose address is
29in \fIlistptr\fP. The list is terminated by a NULL pointer. The yield of the
30function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
31not be obtained.
32.P
33There is a complete description of the PCRE native API in the
34.\" HREF
35\fBpcreapi\fP
36.\"
37page and a description of the POSIX API in the
38.\" HREF
39\fBpcreposix\fP
40.\"
41page.