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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 63 - (show annotations)
Sat Feb 24 21:40:03 2007 UTC (12 years, 3 months ago) by nigel
File MIME type: text/html
File size: 1371 byte(s)
Load pcre-4.0 into code/trunk.
1 <html>
2 <head>
3 <title>pcre_copy_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_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
17 <b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b>
18 <b>int <i>buffersize</i>);</b>
19 </P>
20 <br><b>
21 DESCRIPTION
22 </b><br>
23 <P>
24 This is a convenience function for extracting a captured substring into a given
25 buffer. The arguments are:
26 </P>
27 <P>
28 <pre>
29 <i>subject</i> Subject that has been successfully matched
30 <i>ovector</i> Offset vector that <b>pcre_exec()</b> used
31 <i>stringcount</i> Value returned by <b>pcre_exec()</b>
32 <i>stringnumber</i> Number of the required substring
33 <i>buffer</i> Buffer to receive the string
34 <i>buffersize</i> Size of buffer
35 </PRE>
36 </P>
37 <P>
38 The yield is the legnth of the string, PCRE_ERROR_NOMEMORY if the buffer was
39 too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid.
40 </P>
41 <P>
42 There is a complete description of the PCRE API in the
43 <a href="pcreapi.html"><b>pcreapi</b></a>
44 page.

  ViewVC Help
Powered by ViewVC 1.1.5