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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 63 - (show annotations) (download) (as text)
Sat Feb 24 21:40:03 2007 UTC (7 years, 4 months ago) by nigel
File MIME type: text/html
File size: 1502 byte(s)
Load pcre-4.0 into code/trunk.

1 <html>
2 <head>
3 <title>pcre_copy_named_substring specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 This HTML document has been generated automatically from the original man page.
7 If there is any nonsense in it, please consult the man page, in case the
8 conversion went wrong.<br>
9 <br><b>
10 SYNOPSIS
11 </b><br>
12 <P>
13 <b>#include &#60;pcre.h&#62;</b>
14 </P>
15 <P>
16 <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b>
17 <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
18 <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
19 <b>char *<i>buffer</i>, int <i>buffersize</i>);</b>
20 </P>
21 <br><b>
22 DESCRIPTION
23 </b><br>
24 <P>
25 This is a convenience function for extracting a captured substring, identified
26 by name, into a given buffer. The arguments are:
27 </P>
28 <P>
29 <pre>
30 <i>code</i> Pattern that was successfully matched
31 <i>subject</i> Subject that has been successfully matched
32 <i>ovector</i> Offset vector that <b>pcre_exec()</b> used
33 <i>stringcount</i> Value returned by <b>pcre_exec()</b>
34 <i>stringname</i> Name of the required substring
35 <i>buffer</i> Buffer to receive the string
36 <i>buffersize</i> Size of buffer
37 </PRE>
38 </P>
39 <P>
40 The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
41 too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
42 </P>
43 <P>
44 There is a complete description of the PCRE API in the
45 <a href="pcreapi.html"><b>pcreapi</b></a>
46 page.

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12