2
1
mirror of https://github.com/qpdf/qpdf.git synced 2025-02-15 01:51:41 +00:00
qpdf/external-libs/pcre/doc/pcre_get_substring_list.3
Jay Berkenbilt 582b500cd9 start integrating windows port
git-svn-id: svn+q:///qpdf/trunk@757 71b93d88-0707-0410-a8cf-f5a4172ac649
2009-10-10 15:10:05 +00:00

34 lines
817 B
Groff

.TH PCRE 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.br
.B int pcre_get_substring_list(const char *\fIsubject\fR,
.ti +5n
.B int *\fIovector\fR, int \fIstringcount\fR, "const char ***\fIlistptr\fR);"
.SH DESCRIPTION
.rs
.sp
This is a convenience function for extracting a list of all the captured
substrings. The arguments are:
\fIsubject\fR Subject that has been successfully matched
\fIovector\fR Offset vector that \fBpcre_exec\fR used
\fIstringcount\fR Value returned by \fBpcre_exec\fR
\fIlistptr\fR Where to put a pointer to the list
The yield is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
not be obtained.
There is a complete description of the PCRE API in the
.\" HREF
\fBpcreapi\fR
.\"
page.