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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 99 - (show annotations) (download)
Tue Mar 6 12:27:42 2007 UTC (7 years, 5 months ago) by ph10
File size: 1239 byte(s)
1. Move the comment about version numbers from pcre.h.in to configure.ac 
because that's where they are now set.
2. Update all the man pages to remove the use of .br and .in because this
causes trouble for some HTML converters. Also standardised the final sections 
giving author information and revision date.
3. Update the maintain/132html man page converter to handle .nf/.fi and to barf 
at .br/.in.

1 .TH PCRE_COPY_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 .B int pcre_copy_named_substring(const pcre *\fIcode\fP,
11 .ti +5n
12 .B const char *\fIsubject\fP, int *\fIovector\fP,
13 .ti +5n
14 .B int \fIstringcount\fP, const char *\fIstringname\fP,
15 .ti +5n
16 .B char *\fIbuffer\fP, int \fIbuffersize\fP);
17 .
18 .SH DESCRIPTION
19 .rs
20 .sp
21 This is a convenience function for extracting a captured substring, identified
22 by name, into a given buffer. The arguments are:
23 .sp
24 \fIcode\fP Pattern that was successfully matched
25 \fIsubject\fP Subject that has been successfully matched
26 \fIovector\fP Offset vector that \fBpcre_exec()\fP used
27 \fIstringcount\fP Value returned by \fBpcre_exec()\fP
28 \fIstringname\fP Name of the required substring
29 \fIbuffer\fP Buffer to receive the string
30 \fIbuffersize\fP Size of buffer
31 .sp
32 The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
33 too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
34 .P
35 There is a complete description of the PCRE native API in the
36 .\" HREF
37 \fBpcreapi\fP
38 .\"
39 page and a description of the POSIX API in the
40 .\" HREF
41 \fBpcreposix\fP
42 .\"
43 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