/[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 954 - (show annotations)
Sat Mar 31 18:09:26 2012 UTC (7 years, 4 months ago) by ph10
File size: 1526 byte(s)
Add date and PCRE version to .TH macros of all man pages.
1 .TH PCRE_COPY_NAMED_SUBSTRING 3 "13 January 2012" "PCRE 8.30"
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 .PP
18 .B int pcre16_copy_named_substring(const pcre16 *\fIcode\fP,
19 .ti +5n
20 .B PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
21 .ti +5n
22 .B int \fIstringcount\fP, PCRE_SPTR16 \fIstringname\fP,
23 .ti +5n
24 .B PCRE_UCHAR16 *\fIbuffer\fP, int \fIbuffersize\fP);
25 .
26 .SH DESCRIPTION
27 .rs
28 .sp
29 This is a convenience function for extracting a captured substring, identified
30 by name, into a given buffer. The arguments are:
31 .sp
32 \fIcode\fP Pattern that was successfully matched
33 \fIsubject\fP Subject that has been successfully matched
34 \fIovector\fP Offset vector that \fBpcre[16]_exec()\fP used
35 \fIstringcount\fP Value returned by \fBpcre[16]_exec()\fP
36 \fIstringname\fP Name of the required substring
37 \fIbuffer\fP Buffer to receive the string
38 \fIbuffersize\fP Size of buffer
39 .sp
40 The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
41 too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
42 .P
43 There is a complete description of the PCRE native API in the
44 .\" HREF
45 \fBpcreapi\fP
46 .\"
47 page and a description of the POSIX API in the
48 .\" HREF
49 \fBpcreposix\fP
50 .\"
51 page.

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5