/[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 75 - (hide annotations) (download) (as text)
Sat Feb 24 21:40:37 2007 UTC (7 years, 5 months ago) by nigel
File MIME type: text/html
File size: 1792 byte(s)
Load pcre-5.0 into code/trunk.

1 nigel 63 <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 nigel 75 <h1>pcre_copy_named_substring man page</h1>
7     <p>
8     Return to the <a href="index.html">PCRE index page</a>.
9     </p>
10     <p>
11     This page is part of the PCRE HTML documentation. It was generated automatically
12     from the original man page. If there is any nonsense in it, please consult the
13     man page, in case the conversion went wrong.
14     <br>
15 nigel 63 <br><b>
16     SYNOPSIS
17     </b><br>
18     <P>
19     <b>#include &#60;pcre.h&#62;</b>
20     </P>
21     <P>
22     <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b>
23     <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
24     <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
25     <b>char *<i>buffer</i>, int <i>buffersize</i>);</b>
26     </P>
27     <br><b>
28     DESCRIPTION
29     </b><br>
30     <P>
31     This is a convenience function for extracting a captured substring, identified
32     by name, into a given buffer. The arguments are:
33     <pre>
34     <i>code</i> Pattern that was successfully matched
35     <i>subject</i> Subject that has been successfully matched
36     <i>ovector</i> Offset vector that <b>pcre_exec()</b> used
37     <i>stringcount</i> Value returned by <b>pcre_exec()</b>
38     <i>stringname</i> Name of the required substring
39     <i>buffer</i> Buffer to receive the string
40     <i>buffersize</i> Size of buffer
41 nigel 75 </pre>
42 nigel 63 The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
43     too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
44     </P>
45     <P>
46 nigel 75 There is a complete description of the PCRE native API in the
47 nigel 63 <a href="pcreapi.html"><b>pcreapi</b></a>
48 nigel 75 page and a description of the POSIX API in the
49     <a href="pcreposix.html"><b>pcreposix</b></a>
50 nigel 63 page.
51 nigel 75 <p>
52     Return to the <a href="index.html">PCRE index page</a>.
53     </p>

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12