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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 79 - (show annotations) (download)
Sat Feb 24 21:40:52 2007 UTC (7 years, 4 months ago) by nigel
File size: 1243 byte(s)
Load pcre-6.1 into code/trunk.

1 .TH PCRE_COPY_NAMED_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_copy_named_substring(const pcre *\fIcode\fP,
12 .ti +5n
13 .B const char *\fIsubject\fP, int *\fIovector\fP,
14 .ti +5n
15 .B int \fIstringcount\fP, const char *\fIstringname\fP,
16 .ti +5n
17 .B char *\fIbuffer\fP, int \fIbuffersize\fP);
18 .
19 .SH DESCRIPTION
20 .rs
21 .sp
22 This is a convenience function for extracting a captured substring, identified
23 by name, into a given buffer. The arguments are:
24 .sp
25 \fIcode\fP Pattern that was successfully matched
26 \fIsubject\fP Subject that has been successfully matched
27 \fIovector\fP Offset vector that \fBpcre_exec()\fP used
28 \fIstringcount\fP Value returned by \fBpcre_exec()\fP
29 \fIstringname\fP Name of the required substring
30 \fIbuffer\fP Buffer to receive the string
31 \fIbuffersize\fP Size of buffer
32 .sp
33 The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
34 too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
35 .P
36 There is a complete description of the PCRE native API in the
37 .\" HREF
38 \fBpcreapi\fP
39 .\"
40 page and a description of the POSIX API in the
41 .\" HREF
42 \fBpcreposix\fP
43 .\"
44 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12