trunk/doc/pcre_get_substring.3

.TH PCRE_GET_SUBSTRING 3 "24 June 2012" "PCRE 8.30"
.SH NAME
PCRE - Perl-compatible regular expressions
.SH SYNOPSIS
.rs
.sp
.B #include <pcre.h>
.PP
.nf
.B int pcre_get_substring(const char *\fIsubject\fP, int *\fIovector\fP,
.B "     int \fIstringcount\fP, int \fIstringnumber\fP,"
.B "     const char **\fIstringptr\fP);"
.sp
.B int pcre16_get_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
.B "     int \fIstringcount\fP, int \fIstringnumber\fP,"
.B "     PCRE_SPTR16 *\fIstringptr\fP);"
.sp
.B int pcre32_get_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,
.B "     int \fIstringcount\fP, int \fIstringnumber\fP,"
.B "     PCRE_SPTR32 *\fIstringptr\fP);"
.fi
.
.SH DESCRIPTION
.rs
.sp
This is a convenience function for extracting a captured substring. 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
  \fIstringptr\fP     Where to put the string pointer
.sp
The memory in which the substring is placed is obtained by calling
\fBpcre[16|32]_malloc()\fP. The convenience function
\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,
PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, 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_GET_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	ph10	1339	.nf
10	nigel	75	.B int pcre_get_substring(const char \fIsubject\fP, int \fIovector\fP,
11	ph10	1339	.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
12			.B " const char **\fIstringptr\fP);"
13			.sp
14	ph10	868	.B int pcre16_get_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
15	ph10	1339	.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
16			.B " PCRE_SPTR16 *\fIstringptr\fP);"
17			.sp
18	chpe	1055	.B int pcre32_get_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,
19	ph10	1339	.B " int \fIstringcount\fP, int \fIstringnumber\fP,"
20			.B " PCRE_SPTR32 *\fIstringptr\fP);"
21			.fi
22	nigel	75	.
23	nigel	63	.SH DESCRIPTION
24			.rs
25			.sp
26			This is a convenience function for extracting a captured substring. The
27			arguments are:
28	nigel	75	.sp
29			\fIsubject\fP Subject that has been successfully matched
30	chpe	1055	\fIovector\fP Offset vector that \fBpcre[16\|32]_exec()\fP used
31			\fIstringcount\fP Value returned by \fBpcre[16\|32]_exec()\fP
32	nigel	75	\fIstringnumber\fP Number of the required substring
33			\fIstringptr\fP Where to put the string pointer
34			.sp
35			The memory in which the substring is placed is obtained by calling
36	chpe	1055	\fBpcre[16\|32]_malloc()\fP. The convenience function
37			\fBpcre[16\|32]_free_substring()\fP can be used to free it when it is no longer
38	ph10	868	needed. The yield of the function is the length of the substring,
39			PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
40			PCRE_ERROR_NOSUBSTRING if the string number is invalid.
41	nigel	75	.P
42			There is a complete description of the PCRE native API in the
43	nigel	63	.\" HREF
44	nigel	75	\fBpcreapi\fP
45	nigel	63	.\"
46	nigel	75	page and a description of the POSIX API in the
47			.\" HREF
48			\fBpcreposix\fP
49			.\"
50	nigel	63	page.
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"