← Back to branch summary

~ubuntu-branches/ubuntu/trusty/pcre3/trusty

« back to all changes in this revision

Viewing changes to doc/html/pcre_get_substring_list.html

  • Committer: Package Import Robot
  • Author(s): Mark Baker
  • Date: 2012-03-23 22:34:54 UTC
  • mfrom: (23.1.9 sid)
  • Revision ID: package-import@ubuntu.com-20120323223454-grhqqolk8a7x1h24
Tags: 1:8.30-4
* Reluctantly using an epoch, as it seems the funny version number with
  extra dots causes problems
* Bumped standard version to 3.9.3. No changes needed
* Converted to use new source format / quilt
* Put back obsolete pcre_info() API that upstream have dropped (Closes:
  #665300, #665356)
* Don't include pcregrep binary in debug package

Thanks to Elimar Riesebieter for the conversion to the new source format.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/pcre_get_substring_list.html
22
22
<b>int pcre_get_substring_list(const char *<i>subject</i>,</b>
23
23
<b>int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b>
24
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>
25
29
<br><b>
26
30
DESCRIPTION
27
31
</b><br>
30
34
substrings. The arguments are:
31
35
<pre>
32
36
  <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>
 
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>
35
39
  <i>listptr</i>       Where to put a pointer to the list
36
40
</pre>
37
41
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.
 
42
calling <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
 
44
longer needed. A pointer to a list of pointers is put in the variable whose
 
45
address is in <i>listptr</i>. The list is terminated by a NULL pointer. The
 
46
yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient
 
47
memory could not be obtained.
44
48
</P>
45
49
<P>
46
50
There is a complete description of the PCRE native API in the