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

Contents of /code/trunk/doc/html/pcre_get_substring_list.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 75 - (hide annotations) (download) (as text)
Sat Feb 24 21:40:37 2007 UTC (7 years, 1 month ago) by nigel
File MIME type: text/html
File size: 1728 byte(s)
Load pcre-5.0 into code/trunk.

1 nigel 63 <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 nigel 75 <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 nigel 63 <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_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 nigel 75 </pre>
37     The memory in which the substrings and the list are placed is obtained by
38     calling <b>pcre_malloc()</b>. A pointer to a list of pointers is put in
39     the variable whose address is in <i>listptr</i>. The list is terminated by a
40     NULL pointer. The yield of the function is zero on success or
41     PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained.
42 nigel 63 </P>
43     <P>
44 nigel 75 There is a complete description of the PCRE native API in the
45 nigel 63 <a href="pcreapi.html"><b>pcreapi</b></a>
46 nigel 75 page and a description of the POSIX API in the
47     <a href="pcreposix.html"><b>pcreposix</b></a>
48 nigel 63 page.
49 nigel 75 <p>
50     Return to the <a href="index.html">PCRE index page</a>.
51     </p>

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12