/[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 869 - (show annotations)
Sat Jan 14 11:16:23 2012 UTC (7 years, 2 months ago) by ph10
File MIME type: text/html
File size: 2053 byte(s)
Error occurred while calculating annotation data.
Bring HTML docs up to date.
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 <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 <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 <P>
28 <b>int pcre16_copy_named_substring(const pcre16 *<i>code</i>,</b>
29 <b>PCRE_SPTR16 <i>subject</i>, int *<i>ovector</i>,</b>
30 <b>int <i>stringcount</i>, PCRE_SPTR16 <i>stringname</i>,</b>
31 <b>PCRE_UCHAR16 *<i>buffer</i>, int <i>buffersize</i>);</b>
32 </P>
33 <br><b>
34 DESCRIPTION
35 </b><br>
36 <P>
37 This is a convenience function for extracting a captured substring, identified
38 by name, into a given buffer. The arguments are:
39 <pre>
40 <i>code</i> Pattern that was successfully matched
41 <i>subject</i> Subject that has been successfully matched
42 <i>ovector</i> Offset vector that <b>pcre[16]_exec()</b> used
43 <i>stringcount</i> Value returned by <b>pcre[16]_exec()</b>
44 <i>stringname</i> Name of the required substring
45 <i>buffer</i> Buffer to receive the string
46 <i>buffersize</i> Size of buffer
47 </pre>
48 The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
49 too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
50 </P>
51 <P>
52 There is a complete description of the PCRE native API in the
53 <a href="pcreapi.html"><b>pcreapi</b></a>
54 page and a description of the POSIX API in the
55 <a href="pcreposix.html"><b>pcreposix</b></a>
56 page.
57 <p>
58 Return to the <a href="index.html">PCRE index page</a>.
59 </p>

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

  ViewVC Help
Powered by ViewVC 1.1.5