doc/html/pcre_get_substring_list.html

<html>
<head>
<title>pcre_get_substring_list specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre_get_substring_list man page</h1>
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
<p>
This page is part of the PCRE HTML documentation. It was generated automatically
from the original man page. If there is any nonsense in it, please consult the
man page, in case the conversion went wrong.
<br>
<br><b>
SYNOPSIS
</b><br>
<P>
<b>#include &#60;pcre.h&#62;</b>
</P>
<P>
<b>int pcre_get_substring_list(const char *<i>subject</i>,</b>
<b>int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b>
</P>
<br><b>
DESCRIPTION
</b><br>
<P>
This is a convenience function for extracting a list of all the captured
substrings. The arguments are:
<pre>
  <i>subject</i>       Subject that has been successfully matched
  <i>ovector</i>       Offset vector that <b>pcre_exec</b> used
  <i>stringcount</i>   Value returned by <b>pcre_exec</b>
  <i>listptr</i>       Where to put a pointer to the list
</pre>
The memory in which the substrings and the list are placed is obtained by
calling <b>pcre_malloc()</b>. The convenience function
<b>pcre_free_substring_list()</b> can be used to free it when it is no longer
needed. A pointer to a list of pointers is put in the variable whose address is
in <i>listptr</i>. The list is terminated by a NULL pointer. The yield of the
function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
not be obtained.
</P>
<P>
There is a complete description of the PCRE native API in the
<a href="pcreapi.html"><b>pcreapi</b></a>
page and a description of the POSIX API in the
<a href="pcreposix.html"><b>pcreposix</b></a>
page.
<p>
Return to the <a href="index.html">PCRE index page</a>.
</p>
1	<html>
2	<head>
3	<title>pcre_get_substring_list specification</title>
4	</head>
5	<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6	<h1>pcre_get_substring_list 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_get_substring_list(const char *<i>subject</i>,</b>
23	<b>int <i>ovector</i>, int <i>stringcount</i>, const char **<i>listptr</i>);</b>
24	</P>
25	<br><b>
26	DESCRIPTION
27	</b><br>
28	<P>
29	This is a convenience function for extracting a list of all the captured
30	substrings. The arguments are:
31	<pre>
32	<i>subject</i> Subject that has been successfully matched
33	<i>ovector</i> Offset vector that <b>pcre_exec</b> used
34	<i>stringcount</i> Value returned by <b>pcre_exec</b>
35	<i>listptr</i> Where to put a pointer to the list
36	</pre>
37	The memory in which the substrings and the list are placed is obtained by
38	calling <b>pcre_malloc()</b>. The convenience function
39	<b>pcre_free_substring_list()</b> can be used to free it when it is no longer
40	needed. A pointer to a list of pointers is put in the variable whose address is
41	in <i>listptr</i>. The list is terminated by a NULL pointer. The yield of the
42	function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
43	not be obtained.
44	</P>
45	<P>
46	There is a complete description of the PCRE native API in the
47	<a href="pcreapi.html"><b>pcreapi</b></a>
48	page and a description of the POSIX API in the
49	<a href="pcreposix.html"><b>pcreposix</b></a>
50	page.
51	<p>
52	Return to the <a href="index.html">PCRE index page</a>.
53	</p>
Name	Value
svn:eol-style	native
svn:keywords	"Author Date Id Revision Url"