/[pcre]/code/tags/pcre-8.00/doc/pcre_copy_named_substring.3
ViewVC logotype

Contents of /code/tags/pcre-8.00/doc/pcre_copy_named_substring.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 470 - (show annotations)
Thu Oct 29 09:18:01 2009 UTC (10 years, 1 month ago) by ph10
File size: 1239 byte(s)
Error occurred while calculating annotation data.
Tag the 8.00 release.
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 .B int pcre_copy_named_substring(const pcre *\fIcode\fP,
11 .ti +5n
12 .B const char *\fIsubject\fP, int *\fIovector\fP,
13 .ti +5n
14 .B int \fIstringcount\fP, const char *\fIstringname\fP,
15 .ti +5n
16 .B char *\fIbuffer\fP, int \fIbuffersize\fP);
17 .
18 .SH DESCRIPTION
19 .rs
20 .sp
21 This is a convenience function for extracting a captured substring, identified
22 by name, into a given buffer. The arguments are:
23 .sp
24 \fIcode\fP Pattern that was successfully matched
25 \fIsubject\fP Subject that has been successfully matched
26 \fIovector\fP Offset vector that \fBpcre_exec()\fP used
27 \fIstringcount\fP Value returned by \fBpcre_exec()\fP
28 \fIstringname\fP Name of the required substring
29 \fIbuffer\fP Buffer to receive the string
30 \fIbuffersize\fP Size of buffer
31 .sp
32 The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
33 too small, or PCRE_ERROR_NOSUBSTRING if the string name 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"

  ViewVC Help
Powered by ViewVC 1.1.5