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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 63 by nigel, Sat Feb 24 21:40:03 2007 UTC revision 1339 by ph10, Fri Jun 14 09:09:28 2013 UTC
# Line 3  Line 3 
3  <title>pcre_copy_named_substring specification</title>  <title>pcre_copy_named_substring specification</title>
4  </head>  </head>
5  <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">  <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6  This HTML document has been generated automatically from the original man page.  <h1>pcre_copy_named_substring man page</h1>
7  If there is any nonsense in it, please consult the man page, in case the  <p>
8  conversion went wrong.<br>  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>  <br><b>
16  SYNOPSIS  SYNOPSIS
17  </b><br>  </b><br>
# Line 14  SYNOPSIS Line 20  SYNOPSIS
20  </P>  </P>
21  <P>  <P>
22  <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b>  <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b>
23  <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>  <b>     const char *<i>subject</i>, int *<i>ovector</i>,</b>
24  <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>  <b>     int <i>stringcount</i>, const char *<i>stringname</i>,</b>
25  <b>char *<i>buffer</i>, int <i>buffersize</i>);</b>  <b>     char *<i>buffer</i>, int <i>buffersize</i>);</b>
26    <br>
27    <br>
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    <br>
33    <br>
34    <b>int pcre32_copy_named_substring(const pcre32 *<i>code</i>,</b>
35    <b>     PCRE_SPTR32 <i>subject</i>, int *<i>ovector</i>,</b>
36    <b>     int <i>stringcount</i>, PCRE_SPTR32 <i>stringname</i>,</b>
37    <b>     PCRE_UCHAR32 *<i>buffer</i>, int <i>buffersize</i>);</b>
38  </P>  </P>
39  <br><b>  <br><b>
40  DESCRIPTION  DESCRIPTION
# Line 24  DESCRIPTION Line 42  DESCRIPTION
42  <P>  <P>
43  This is a convenience function for extracting a captured substring, identified  This is a convenience function for extracting a captured substring, identified
44  by name, into a given buffer. The arguments are:  by name, into a given buffer. The arguments are:
 </P>  
 <P>  
45  <pre>  <pre>
46    <i>code</i>          Pattern that was successfully matched    <i>code</i>          Pattern that was successfully matched
47    <i>subject</i>       Subject that has been successfully matched    <i>subject</i>       Subject that has been successfully matched
48    <i>ovector</i>       Offset vector that <b>pcre_exec()</b> used    <i>ovector</i>       Offset vector that <b>pcre[16|32]_exec()</b> used
49    <i>stringcount</i>   Value returned by <b>pcre_exec()</b>    <i>stringcount</i>   Value returned by <b>pcre[16|32]_exec()</b>
50    <i>stringname</i>    Name of the required substring    <i>stringname</i>    Name of the required substring
51    <i>buffer</i>        Buffer to receive the string    <i>buffer</i>        Buffer to receive the string
52    <i>buffersize</i>    Size of buffer    <i>buffersize</i>    Size of buffer
53  </PRE>  </pre>
 </P>  
 <P>  
54  The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was  The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was
55  too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.  too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.
56  </P>  </P>
57  <P>  <P>
58  There is a complete description of the PCRE API in the  There is a complete description of the PCRE native API in the
59  <a href="pcreapi.html"><b>pcreapi</b></a>  <a href="pcreapi.html"><b>pcreapi</b></a>
60    page and a description of the POSIX API in the
61    <a href="pcreposix.html"><b>pcreposix</b></a>
62  page.  page.
63    <p>
64    Return to the <a href="index.html">PCRE index page</a>.
65    </p>

Legend:
Removed from v.63  
changed lines
  Added in v.1339

  ViewVC Help
Powered by ViewVC 1.1.5