/[pcre]/code/trunk/doc/pcre_get_substring.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_get_substring.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 96 - (show annotations) (download)
Fri Mar 2 13:10:43 2007 UTC (7 years, 5 months ago) by nigel
File size: 1269 byte(s)
 r6896@hex:  nm | 2007-03-02 13:09:14 +0000
 Added EOL and keywork properties throughout

1 .TH PCRE_GET_SUBSTRING 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\fP, int *\fIovector\fP,
12 .ti +5n
13 .B int \fIstringcount\fP, int \fIstringnumber\fP,
14 .ti +5n
15 .B const char **\fIstringptr\fP);
16 .
17 .SH DESCRIPTION
18 .rs
19 .sp
20 This is a convenience function for extracting a captured substring. The
21 arguments are:
22 .sp
23 \fIsubject\fP Subject that has been successfully matched
24 \fIovector\fP Offset vector that \fBpcre_exec()\fP used
25 \fIstringcount\fP Value returned by \fBpcre_exec()\fP
26 \fIstringnumber\fP Number of the required substring
27 \fIstringptr\fP Where to put the string pointer
28 .sp
29 The memory in which the substring is placed is obtained by calling
30 \fBpcre_malloc()\fP. The convenience function \fBpcre_free_substring()\fP can
31 be used to free it when it is no longer needed. The yield of the function is
32 the length of the substring, PCRE_ERROR_NOMEMORY if sufficient memory could not
33 be obtained, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
34 .P
35 There is a complete description of the PCRE native API in the
36 .\" HREF
37 \fBpcreapi\fP
38 .\"
39 page and a description of the POSIX API in the
40 .\" HREF
41 \fBpcreposix\fP
42 .\"
43 page.

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12