/[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 93 - (hide annotations) (download)
Sat Feb 24 21:41:42 2007 UTC (7 years, 1 month ago) by nigel
File size: 1375 byte(s)
Load pcre-7.0 into code/trunk.

1 nigel 79 .TH PCRE_GET_NAMED_SUBSTRING 3
2 nigel 63 .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 nigel 75 .B int pcre_get_named_substring(const pcre *\fIcode\fP,
12 nigel 63 .ti +5n
13 nigel 75 .B const char *\fIsubject\fP, int *\fIovector\fP,
14 nigel 63 .ti +5n
15 nigel 75 .B int \fIstringcount\fP, const char *\fIstringname\fP,
16 nigel 63 .ti +5n
17 nigel 75 .B const char **\fIstringptr\fP);
18     .
19 nigel 63 .SH DESCRIPTION
20     .rs
21     .sp
22     This is a convenience function for extracting a captured substring by name. The
23     arguments are:
24 nigel 75 .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 nigel 93 \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 nigel 75 .P
38     There is a complete description of the PCRE native API in the
39 nigel 63 .\" HREF
40 nigel 75 \fBpcreapi\fP
41 nigel 63 .\"
42 nigel 75 page and a description of the POSIX API in the
43     .\" HREF
44     \fBpcreposix\fP
45     .\"
46 nigel 63 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12