embedaddon/pcre/doc/pcre_get_substring_list.3 - diff

Return to pcre_get_substring_list.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Diff for /embedaddon/pcre/doc/pcre_get_substring_list.3 between versions 1.1.1.2 and 1.1.1.5

version 1.1.1.2, 2012/02/21 23:50:25	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,
.PP
.B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP,	.B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP,
.ti +5n	.B " int \fIovector\fP, int \fIstringcount\fP, PCRE_SPTR16 *\fIlistptr\fP);"
.B int \fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR16 *\fIlistptr\fP);"	.
	.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 22 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[16]_exec\fP used	\fIovector\fP Offset vector that \fBpcre[16\|32]_exec\fP used
\fIstringcount\fP Value returned by \fBpcre[16]_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[16]_malloc()\fP. The convenience function	calling \fBpcre[16\|32]_malloc()\fP. The convenience function
\fBpcre[16]_free_substring_list()\fP can be used to free it when it is no	\fBpcre[16\|32]_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	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	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	yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.1.1.2
changed lines
	Added in v.1.1.1.5