/[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 1339 - (show annotations)
Fri Jun 14 09:09:28 2013 UTC (6 years ago) by ph10
File size: 1877 byte(s)
Update man pages to avoid the use of .ti (which causes difficulties for some 
translation software).
1 .TH PCRE_GET_NAMED_SUBSTRING 3 "24 June 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 .nf
10 .B int pcre_get_named_substring(const pcre *\fIcode\fP,
11 .B " const char *\fIsubject\fP, int *\fIovector\fP,"
12 .B " int \fIstringcount\fP, const char *\fIstringname\fP,"
13 .B " const char **\fIstringptr\fP);"
14 .sp
15 .B int pcre16_get_named_substring(const pcre16 *\fIcode\fP,
16 .B " PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,"
17 .B " int \fIstringcount\fP, PCRE_SPTR16 \fIstringname\fP,"
18 .B " PCRE_SPTR16 *\fIstringptr\fP);"
19 .sp
20 .B int pcre32_get_named_substring(const pcre32 *\fIcode\fP,
21 .B " PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,"
22 .B " int \fIstringcount\fP, PCRE_SPTR32 \fIstringname\fP,"
23 .B " PCRE_SPTR32 *\fIstringptr\fP);"
24 .fi
25 .
26 .SH DESCRIPTION
27 .rs
28 .sp
29 This is a convenience function for extracting a captured substring by name. The
30 arguments are:
31 .sp
32 \fIcode\fP Compiled pattern
33 \fIsubject\fP Subject that has been successfully matched
34 \fIovector\fP Offset vector that \fBpcre[16|32]_exec()\fP used
35 \fIstringcount\fP Value returned by \fBpcre[16|32]_exec()\fP
36 \fIstringname\fP Name of the required substring
37 \fIstringptr\fP Where to put the string pointer
38 .sp
39 The memory in which the substring is placed is obtained by calling
40 \fBpcre[16|32]_malloc()\fP. The convenience function
41 \fBpcre[16|32]_free_substring()\fP can be used to free it when it is no longer
42 needed. The yield of the function is the length of the extracted substring,
43 PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, or
44 PCRE_ERROR_NOSUBSTRING if the string name is invalid.
45 .P
46 There is a complete description of the PCRE native API in the
47 .\" HREF
48 \fBpcreapi\fP
49 .\"
50 page and a description of the POSIX API in the
51 .\" HREF
52 \fBpcreposix\fP
53 .\"
54 page.

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5