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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 96 - (show annotations) (download)
Fri Mar 2 13:10:43 2007 UTC (7 years, 6 months ago) by nigel
File size: 1375 byte(s)
 r6896@hex:  nm | 2007-03-02 13:09:14 +0000
 Added EOL and keywork properties throughout

1 .TH PCRE_GET_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_get_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 const char **\fIstringptr\fP);
18 .
19 .SH DESCRIPTION
20 .rs
21 .sp
22 This is a convenience function for extracting a captured substring by name. The
23 arguments are:
24 .sp
25 \fIcode\fP Compiled pattern
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 \fIstringptr\fP Where to put the string pointer
31 .sp
32 The memory in which the substring is placed is obtained by calling
33 \fBpcre_malloc()\fP. The convenience function \fBpcre_free_substring()\fP can
34 be used to free it when it is no longer needed. The yield of the function is
35 the length of the extracted substring, PCRE_ERROR_NOMEMORY if sufficient memory
36 could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
37 .P
38 There is a complete description of the PCRE native API in the
39 .\" HREF
40 \fBpcreapi\fP
41 .\"
42 page and a description of the POSIX API in the
43 .\" HREF
44 \fBpcreposix\fP
45 .\"
46 page.

Properties

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12