/[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 79 - (hide annotations) (download)
Sat Feb 24 21:40:52 2007 UTC (7 years, 8 months ago) by nigel
File size: 1164 byte(s)
Load pcre-6.1 into code/trunk.

1 nigel 79 .TH PCRE_GET_SUBSTRING 3
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     .br
11 nigel 75 .B int pcre_get_substring(const char *\fIsubject\fP, int *\fIovector\fP,
12 nigel 63 .ti +5n
13 nigel 75 .B int \fIstringcount\fP, int \fIstringnumber\fP,
14 nigel 63 .ti +5n
15 nigel 75 .B const char **\fIstringptr\fP);
16     .
17 nigel 63 .SH DESCRIPTION
18     .rs
19     .sp
20     This is a convenience function for extracting a captured substring. The
21     arguments are:
22 nigel 75 .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 yield of the function is the length of the substring,
31     PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
32     PCRE_ERROR_NOSUBSTRING if the string number is invalid.
33     .P
34     There is a complete description of the PCRE native API in the
35 nigel 63 .\" HREF
36 nigel 75 \fBpcreapi\fP
37 nigel 63 .\"
38 nigel 75 page and a description of the POSIX API in the
39     .\" HREF
40     \fBpcreposix\fP
41     .\"
42 nigel 63 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12