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>
8Return to the <a href="index.html">PCRE index page</a>.
9</p>
10<p>
11This page is part of the PCRE HTML documentation. It was generated automatically
12from the original man page. If there is any nonsense in it, please consult the
13man page, in case the conversion went wrong.
14<br>
15<br><b>
16SYNOPSIS
17</b><br>
18<P>
19<b>#include &#60;pcre.h&#62;</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<P>
26<b>int pcre16_get_substring_list(PCRE_SPTR16 <i>subject</i>,</b>
27<b>int *<i>ovector</i>, int <i>stringcount</i>, PCRE_SPTR16 **<i>listptr</i>);</b>
28</P>
29<br><b>
30DESCRIPTION
31</b><br>
32<P>
33This is a convenience function for extracting a list of all the captured
34substrings. The arguments are:
35<pre>
36  <i>subject</i>       Subject that has been successfully matched
37  <i>ovector</i>       Offset vector that <b>pcre[16]_exec</b> used
38  <i>stringcount</i>   Value returned by <b>pcre[16]_exec</b>
39  <i>listptr</i>       Where to put a pointer to the list
40</pre>
41The memory in which the substrings and the list are placed is obtained by
42calling <b>pcre[16]_malloc()</b>. The convenience function
43<b>pcre[16]_free_substring_list()</b> can be used to free it when it is no
44longer needed. A pointer to a list of pointers is put in the variable whose
45address is in <i>listptr</i>. The list is terminated by a NULL pointer. The
46yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient
47memory could not be obtained.
48</P>
49<P>
50There is a complete description of the PCRE native API in the
51<a href="pcreapi.html"><b>pcreapi</b></a>
52page and a description of the POSIX API in the
53<a href="pcreposix.html"><b>pcreposix</b></a>
54page.
55<p>
56Return to the <a href="index.html">PCRE index page</a>.
57</p>
58