← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/pcre_get_substring_list.3

  • 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/pcre_get_substring_list.3
10
10
.B int pcre_get_substring_list(const char *\fIsubject\fP,
11
11
.ti +5n
12
12
.B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
 
13
.PP
 
14
.B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP,
 
15
.ti +5n
 
16
.B int *\fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR16 **\fIlistptr\fP);"
13
17
.
14
18
.SH DESCRIPTION
15
19
.rs
18
22
substrings. The arguments are:
19
23
.sp
20
24
  \fIsubject\fP       Subject that has been successfully matched
21
 
  \fIovector\fP       Offset vector that \fBpcre_exec\fP used
22
 
  \fIstringcount\fP   Value returned by \fBpcre_exec\fP
 
25
  \fIovector\fP       Offset vector that \fBpcre[16]_exec\fP used
 
26
  \fIstringcount\fP   Value returned by \fBpcre[16]_exec\fP
23
27
  \fIlistptr\fP       Where to put a pointer to the list
24
28
.sp
25
29
The memory in which the substrings and the list are placed is obtained by
26
 
calling \fBpcre_malloc()\fP. The convenience function
27
 
\fBpcre_free_substring_list()\fP can be used to free it when it is no longer
28
 
needed. A pointer to a list of pointers is put in the variable whose address is
29
 
in \fIlistptr\fP. The list is terminated by a NULL pointer. The yield of the
30
 
function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could
31
 
not be obtained.
 
30
calling \fBpcre[16]_malloc()\fP. The convenience function
 
31
\fBpcre[16]_free_substring_list()\fP can be used to free it when it is no
 
32
longer needed. A pointer to a list of pointers is put in the variable whose
 
33
address is in \fIlistptr\fP. The list is terminated by a NULL pointer. The
 
34
yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient
 
35
memory could not be obtained.
32
36
.P
33
37
There is a complete description of the PCRE native API in the
34
38
.\" HREF