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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1339 - (show annotations) (download)
Fri Jun 14 09:09:28 2013 UTC (14 months, 2 weeks ago) by ph10
File size: 1545 byte(s)
Update man pages to avoid the use of .ti (which causes difficulties for some 
translation software).

1 .TH PCRE_COPY_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_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,
11 .B " int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,"
12 .B " int \fIbuffersize\fP);"
13 .sp
14 .B int pcre16_copy_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
15 .B " int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR16 *\fIbuffer\fP,"
16 .B " int \fIbuffersize\fP);"
17 .sp
18 .B int pcre32_copy_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP,
19 .B " int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR32 *\fIbuffer\fP,"
20 .B " int \fIbuffersize\fP);"
21 .fi
22 .
23 .SH DESCRIPTION
24 .rs
25 .sp
26 This is a convenience function for extracting a captured substring into a given
27 buffer. The arguments are:
28 .sp
29 \fIsubject\fP Subject that has been successfully matched
30 \fIovector\fP Offset vector that \fBpcre[16|32]_exec()\fP used
31 \fIstringcount\fP Value returned by \fBpcre[16|32]_exec()\fP
32 \fIstringnumber\fP Number of the required substring
33 \fIbuffer\fP Buffer to receive the string
34 \fIbuffersize\fP Size of buffer
35 .sp
36 The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was
37 too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
38 .P
39 There is a complete description of the PCRE native API in the
40 .\" HREF
41 \fBpcreapi\fP
42 .\"
43 page and a description of the POSIX API in the
44 .\" HREF
45 \fBpcreposix\fP
46 .\"
47 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