version 1.1.1.1, 2012/02/21 23:05:51
|
version 1.1.1.5, 2014/06/15 19:46:04
|
Line 1
|
Line 1
|
.TH PCRE_GET_SUBSTRING_LIST 3 | .TH PCRE_GET_SUBSTRING_LIST 3 "24 June 2012" "PCRE 8.30" |
.SH NAME |
.SH NAME |
PCRE - Perl-compatible regular expressions |
PCRE - Perl-compatible regular expressions |
.SH SYNOPSIS |
.SH SYNOPSIS |
Line 6 PCRE - Perl-compatible regular expressions
|
Line 6 PCRE - Perl-compatible regular expressions
|
.sp |
.sp |
.B #include <pcre.h> |
.B #include <pcre.h> |
.PP |
.PP |
.SM | .nf |
.B int pcre_get_substring_list(const char *\fIsubject\fP, |
.B int pcre_get_substring_list(const char *\fIsubject\fP, |
.ti +5n | .B " int *\fIovector\fP, int \fIstringcount\fP, const char ***\fIlistptr\fP);" |
.B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);" | . |
| .B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP, |
| .B " int *\fIovector\fP, int \fIstringcount\fP, PCRE_SPTR16 **\fIlistptr\fP);" |
| .sp |
| .B int pcre32_get_substring_list(PCRE_SPTR32 \fIsubject\fP, |
| .B " int *\fIovector\fP, int \fIstringcount\fP, PCRE_SPTR32 **\fIlistptr\fP);" |
| .fi |
. |
. |
.SH DESCRIPTION |
.SH DESCRIPTION |
.rs |
.rs |
Line 18 This is a convenience function for extracting a list o
|
Line 24 This is a convenience function for extracting a list o
|
substrings. The arguments are: |
substrings. The arguments are: |
.sp |
.sp |
\fIsubject\fP Subject that has been successfully matched |
\fIsubject\fP Subject that has been successfully matched |
\fIovector\fP Offset vector that \fBpcre_exec\fP used | \fIovector\fP Offset vector that \fBpcre[16|32]_exec\fP used |
\fIstringcount\fP Value returned by \fBpcre_exec\fP | \fIstringcount\fP Value returned by \fBpcre[16|32]_exec\fP |
\fIlistptr\fP Where to put a pointer to the list |
\fIlistptr\fP Where to put a pointer to the list |
.sp |
.sp |
The memory in which the substrings and the list are placed is obtained by |
The memory in which the substrings and the list are placed is obtained by |
calling \fBpcre_malloc()\fP. The convenience function | calling \fBpcre[16|32]_malloc()\fP. The convenience function |
\fBpcre_free_substring_list()\fP can be used to free it when it is no longer | \fBpcre[16|32]_free_substring_list()\fP can be used to free it when it is no |
needed. A pointer to a list of pointers is put in the variable whose address is | longer needed. A pointer to a list of pointers is put in the variable whose |
in \fIlistptr\fP. The list is terminated by a NULL pointer. The yield of the | address is in \fIlistptr\fP. The list is terminated by a NULL pointer. The |
function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could | yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient |
not be obtained. | memory could not be obtained. |
.P |
.P |
There is a complete description of the PCRE native API in the |
There is a complete description of the PCRE native API in the |
.\" HREF |
.\" HREF |