trunk/doc/pcre_copy_substring.3

.TH PCRE_COPY_SUBSTRING 3 "24 June 2012" "PCRE 8.30"
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,
.ti +5n
.B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,
.ti +5n
.B int \fIbuffersize\fP);
.PP
.B int pcre16_copy_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
.ti +5n
.B int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR16 *\fIbuffer\fP,
.ti +5n
.B int \fIbuffersize\fP);
.PP
.B int pcre32_copy_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,
.ti +5n
.B int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR32 *\fIbuffer\fP,
.ti +5n
.B int \fIbuffersize\fP);
.
.SH DESCRIPTION
.rs
.sp
This is a convenience function for extracting a captured substring into a given
buffer. The arguments are:
.sp
  \fIsubject\fP       Subject that has been successfully matched
  \fIovector\fP       Offset vector that \fBpcre[16|32]_exec()\fP used
  \fIstringcount\fP   Value returned by \fBpcre[16|32]_exec()\fP
  \fIstringnumber\fP  Number of the required substring
  \fIbuffer\fP        Buffer to receive the string
  \fIbuffersize\fP    Size of buffer
.sp
The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was
too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
.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.
1	chpe	1055	.TH PCRE_COPY_SUBSTRING 3 "24 June 2012" "PCRE 8.30"
2	nigel	63	.SH NAME
3			PCRE - Perl-compatible regular expressions
4			.SH SYNOPSIS
5			.rs
6			.sp
7			.B #include <pcre.h>
8			.PP
9			.SM
10	nigel	75	.B int pcre_copy_substring(const char \fIsubject\fP, int \fIovector\fP,
11	nigel	63	.ti +5n
12	nigel	75	.B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,
13	nigel	63	.ti +5n
14	nigel	75	.B int \fIbuffersize\fP);
15	ph10	868	.PP
16			.B int pcre16_copy_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
17			.ti +5n
18			.B int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR16 *\fIbuffer\fP,
19			.ti +5n
20			.B int \fIbuffersize\fP);
21	chpe	1055	.PP
22			.B int pcre32_copy_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,
23			.ti +5n
24			.B int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR32 *\fIbuffer\fP,
25			.ti +5n
26			.B int \fIbuffersize\fP);
27	nigel	75	.
28	nigel	63	.SH DESCRIPTION
29			.rs
30			.sp
31			This is a convenience function for extracting a captured substring into a given
32			buffer. The arguments are:
33	nigel	75	.sp
34			\fIsubject\fP Subject that has been successfully matched
35	chpe	1055	\fIovector\fP Offset vector that \fBpcre[16\|32]_exec()\fP used
36			\fIstringcount\fP Value returned by \fBpcre[16\|32]_exec()\fP
37	nigel	75	\fIstringnumber\fP Number of the required substring
38			\fIbuffer\fP Buffer to receive the string
39			\fIbuffersize\fP Size of buffer
40			.sp
41	nigel	93	The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was
42	nigel	63	too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
43	nigel	75	.P
44			There is a complete description of the PCRE native API in the
45	nigel	63	.\" HREF
46	nigel	75	\fBpcreapi\fP
47	nigel	63	.\"
48	nigel	75	page and a description of the POSIX API in the
49			.\" HREF
50			\fBpcreposix\fP
51			.\"
52	nigel	63	page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"