42 lines
1.3 KiB
Groff
42 lines
1.3 KiB
Groff
.TH PCRE_GET_SUBSTRING_LIST 3
|
|
.SH NAME
|
|
PCRE - Perl-compatible regular expressions
|
|
.SH SYNOPSIS
|
|
.rs
|
|
.sp
|
|
.B #include <pcre.h>
|
|
.PP
|
|
.SM
|
|
.B int pcre_get_substring_list(const char *\fIsubject\fP,
|
|
.ti +5n
|
|
.B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
|
|
.
|
|
.SH DESCRIPTION
|
|
.rs
|
|
.sp
|
|
This is a convenience function for extracting a list of all the captured
|
|
substrings. The arguments are:
|
|
.sp
|
|
\fIsubject\fP Subject that has been successfully matched
|
|
\fIovector\fP Offset vector that \fBpcre_exec\fP used
|
|
\fIstringcount\fP Value returned by \fBpcre_exec\fP
|
|
\fIlistptr\fP Where to put a pointer to the list
|
|
.sp
|
|
The memory in which the substrings and the list are placed is obtained by
|
|
calling \fBpcre_malloc()\fP. The convenience function
|
|
\fBpcre_free_substring_list()\fP can be used to free it when it is no longer
|
|
needed. A pointer to a list of pointers is put in the variable whose address is
|
|
in \fIlistptr\fP. The list is terminated by a NULL pointer. The yield of the
|
|
function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
|
|
not be obtained.
|
|
.P
|
|
There is a complete description of the PCRE native API in the
|
|
.\" HREF
|
|
\fBpcreapi\fP
|
|
.\"
|
|
page and a description of the POSIX API in the
|
|
.\" HREF
|
|
\fBpcreposix\fP
|
|
.\"
|
|
page.
|