ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1194 - (show annotations)
Wed Oct 31 17:42:29 2012 UTC (6 years, 9 months ago) by ph10
File MIME type: text/html
File size: 2181 byte(s)
More documentation updates
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>
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 <P>
30 <b>int pcre32_get_substring_list(PCRE_SPTR32 <i>subject</i>,</b>
31 <b>int *<i>ovector</i>, int <i>stringcount</i>, PCRE_SPTR32 **<i>listptr</i>);</b>
32 </P>
33 <br><b>
35 </b><br>
36 <P>
37 This is a convenience function for extracting a list of all the captured
38 substrings. The arguments are:
39 <pre>
40 <i>subject</i> Subject that has been successfully matched
41 <i>ovector</i> Offset vector that <b>pcre[16|32]_exec</b> used
42 <i>stringcount</i> Value returned by <b>pcre[16|32]_exec</b>
43 <i>listptr</i> Where to put a pointer to the list
44 </pre>
45 The memory in which the substrings and the list are placed is obtained by
46 calling <b>pcre[16|32]_malloc()</b>. The convenience function
47 <b>pcre[16|32]_free_substring_list()</b> can be used to free it when it is no
48 longer needed. A pointer to a list of pointers is put in the variable whose
49 address is in <i>listptr</i>. The list is terminated by a NULL pointer. The
50 yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient
51 memory could not be obtained.
52 </P>
53 <P>
54 There is a complete description of the PCRE native API in the
55 <a href="pcreapi.html"><b>pcreapi</b></a>
56 page and a description of the POSIX API in the
57 <a href="pcreposix.html"><b>pcreposix</b></a>
58 page.
59 <p>
60 Return to the <a href="index.html">PCRE index page</a>.
61 </p>


Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

  ViewVC Help
Powered by ViewVC 1.1.5