Annotation of embedaddon/pcre/doc/html/pcre_copy_named_substring.html, revision 1.1.1.3
1.1 misho 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 <pcre.h></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>
1.1.1.2 misho 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>
1.1.1.3 ! misho 33: <P>
! 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>
1.1 misho 39: <br><b>
40: DESCRIPTION
41: </b><br>
42: <P>
43: This is a convenience function for extracting a captured substring, identified
44: by name, into a given buffer. The arguments are:
45: <pre>
46: <i>code</i> Pattern that was successfully matched
47: <i>subject</i> Subject that has been successfully matched
1.1.1.3 ! misho 48: <i>ovector</i> Offset vector that <b>pcre[16|32]_exec()</b> used
! 49: <i>stringcount</i> Value returned by <b>pcre[16|32]_exec()</b>
1.1 misho 50: <i>stringname</i> Name of the required substring
51: <i>buffer</i> Buffer to receive the string
52: <i>buffersize</i> Size of buffer
53: </pre>
54: 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.
56: </P>
57: <P>
58: There is a complete description of the PCRE native API in the
59: <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.
63: <p>
64: Return to the <a href="index.html">PCRE index page</a>.
65: </p>
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>