trunk/doc/pcre_copy_substring.3

.TH PCRE 3
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.SM
.br
.B int pcre_copy_substring(const char *\fIsubject\fR, int *\fIovector\fR,
.ti +5n
.B int \fIstringcount\fR, int \fIstringnumber\fR, char *\fIbuffer\fR,
.ti +5n
.B int \fIbuffersize\fR);

.SH DESCRIPTION
.rs
.sp
This is a convenience function for extracting a captured substring into a given
buffer. 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
  \fIstringnumber\fR  Number of the required substring
  \fIbuffer\fR        Buffer to receive the string
  \fIbuffersize\fR    Size of buffer

The yield is the legnth of the string, PCRE_ERROR_NOMEMORY if the buffer was
too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.

There is a complete description of the PCRE API in the
.\" HREF
\fBpcreapi\fR
.\"
page.
1	nigel	63	.TH PCRE 3
2			.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			.br
11			.B int pcre_copy_substring(const char \fIsubject\fR, int \fIovector\fR,
12			.ti +5n
13			.B int \fIstringcount\fR, int \fIstringnumber\fR, char *\fIbuffer\fR,
14			.ti +5n
15			.B int \fIbuffersize\fR);
16
17			.SH DESCRIPTION
18			.rs
19			.sp
20			This is a convenience function for extracting a captured substring into a given
21			buffer. The arguments are:
22
23			\fIsubject\fR Subject that has been successfully matched
24			\fIovector\fR Offset vector that \fBpcre_exec()\fR used
25			\fIstringcount\fR Value returned by \fBpcre_exec()\fR
26			\fIstringnumber\fR Number of the required substring
27			\fIbuffer\fR Buffer to receive the string
28			\fIbuffersize\fR Size of buffer
29
30			The yield is the legnth of the string, PCRE_ERROR_NOMEMORY if the buffer was
31			too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
32
33			There is a complete description of the PCRE API in the
34			.\" HREF
35			\fBpcreapi\fR
36			.\"
37			page.