/[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 63 - (show annotations) (download)
Sat Feb 24 21:40:03 2007 UTC (7 years, 7 months ago) by nigel
File size: 1130 byte(s)
Load pcre-4.0 into code/trunk.

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_copy_named_substring(const pcre *\fIcode\fR,
12 .ti +5n
13 .B const char *\fIsubject\fR, int *\fIovector\fR,
14 .ti +5n
15 .B int \fIstringcount\fR, const char *\fIstringname\fR,
16 .ti +5n
17 .B char *\fIbuffer\fR, int \fIbuffersize\fR);
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
25 \fIcode\fR Pattern that was successfully matched
26 \fIsubject\fR Subject that has been successfully matched
27 \fIovector\fR Offset vector that \fBpcre_exec()\fR used
28 \fIstringcount\fR Value returned by \fBpcre_exec()\fR
29 \fIstringname\fR Name of the required substring
30 \fIbuffer\fR Buffer to receive the string
31 \fIbuffersize\fR Size of buffer
32
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
36 There is a complete description of the PCRE API in the
37 .\" HREF
38 \fBpcreapi\fR
39 .\"
40 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12