1 |
.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_get_substring(const char *\fIsubject\fR, int *\fIovector\fR,
|
12 |
.ti +5n
|
13 |
.B int \fIstringcount\fR, int \fIstringnumber\fR,
|
14 |
.ti +5n
|
15 |
.B const char **\fIstringptr\fR);
|
16 |
|
17 |
.SH DESCRIPTION
|
18 |
.rs
|
19 |
.sp
|
20 |
This is a convenience function for extracting a captured substring. The
|
21 |
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 |
\fIstringptr\fR Where to put the string pointer
|
28 |
|
29 |
The yield is the length of the substring, PCRE_ERROR_NOMEMORY if sufficient
|
30 |
memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string number is
|
31 |
invalid.
|
32 |
|
33 |
There is a complete description of the PCRE API in the
|
34 |
.\" HREF
|
35 |
\fBpcreapi\fR
|
36 |
.\"
|
37 |
page.
|