/[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 954 - (hide annotations) (download)
Sat Mar 31 18:09:26 2012 UTC (2 years, 8 months ago) by ph10
File size: 1344 byte(s)
Add date and PCRE version to .TH macros of all man pages.

1 ph10 954 .TH PCRE_COPY_SUBSTRING 3 "13 January 2012" "PCRE 8.30"
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 nigel 75 .B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP,
11 nigel 63 .ti +5n
12 nigel 75 .B int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP,
13 nigel 63 .ti +5n
14 nigel 75 .B int \fIbuffersize\fP);
15 ph10 868 .PP
16     .B int pcre16_copy_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP,
17     .ti +5n
18     .B int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR16 *\fIbuffer\fP,
19     .ti +5n
20     .B int \fIbuffersize\fP);
21 nigel 75 .
22 nigel 63 .SH DESCRIPTION
23     .rs
24     .sp
25     This is a convenience function for extracting a captured substring into a given
26     buffer. The arguments are:
27 nigel 75 .sp
28     \fIsubject\fP Subject that has been successfully matched
29 ph10 868 \fIovector\fP Offset vector that \fBpcre[16]_exec()\fP used
30     \fIstringcount\fP Value returned by \fBpcre[16]_exec()\fP
31 nigel 75 \fIstringnumber\fP Number of the required substring
32     \fIbuffer\fP Buffer to receive the string
33     \fIbuffersize\fP Size of buffer
34     .sp
35 nigel 93 The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was
36 nigel 63 too small, or PCRE_ERROR_NOSUBSTRING if the string number 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.

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