embedaddon/pcre/doc/pcre_get_substring.3 - diff

Return to pcre_get_substring.3 CVS log

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

Diff for /embedaddon/pcre/doc/pcre_get_substring.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:05
Line 1	Line 1
.TH PCRE_GET_SUBSTRING 3	.TH PCRE_GET_SUBSTRING 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(const char \fIsubject\fP, int \fIovector\fP,	.B int pcre_get_substring(const char \fIsubject\fP, int \fIovector\fP,
.ti +5n	.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
.B int \fIstringcount\fP, int \fIstringnumber\fP,	.B " const char **\fIstringptr\fP);"
.ti +5n	.sp
.B const char **\fIstringptr\fP);
.PP
.B int pcre16_get_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,	.B int pcre16_get_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
.ti +5n	.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
.B int \fIstringcount\fP, int \fIstringnumber\fP,	.B " PCRE_SPTR16 *\fIstringptr\fP);"
.ti +5n	.sp
.B PCRE_SPTR16 *\fIstringptr\fP);	.
	.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
	.B " PCRE_SPTR32 *\fIstringptr\fP);"
	.fi
.	.
.SH DESCRIPTION	.SH DESCRIPTION
.rs	.rs
Line 26 This is a convenience function for extracting a captur	Line 27 This is a convenience function for extracting a captur
arguments are:	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
\fIstringnumber\fP Number of the required substring	\fIstringnumber\fP Number of the required substring
\fIstringptr\fP Where to put the string pointer	\fIstringptr\fP Where to put the string pointer
.sp	.sp
The memory in which the substring is placed is obtained by calling	The memory in which the substring is placed is obtained by calling
\fBpcre[16]_malloc()\fP. The convenience function	\fBpcre[16\|32]_malloc()\fP. The convenience function
\fBpcre[16]_free_substring()\fP can be used to free it when it is no longer	\fBpcre[16\|32]_free_substring()\fP can be used to free it when it is no longer
needed. The yield of the function is the length of the substring,	needed. The yield of the function is the length of the substring,
PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or	PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
PCRE_ERROR_NOSUBSTRING if the string number is invalid.	PCRE_ERROR_NOSUBSTRING if the string number is invalid.

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

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