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

Diff of /code/trunk/doc/pcre_get_substring_list.3

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 63 by nigel, Sat Feb 24 21:40:03 2007 UTC revision 75 by nigel, Sat Feb 24 21:40:37 2007 UTC
# Line 8  PCRE - Perl-compatible regular expressio Line 8  PCRE - Perl-compatible regular expressio
8  .PP  .PP
9  .SM  .SM
10  .br  .br
11  .B int pcre_get_substring_list(const char *\fIsubject\fR,  .B int pcre_get_substring_list(const char *\fIsubject\fP,
12  .ti +5n  .ti +5n
13  .B int *\fIovector\fR, int \fIstringcount\fR, "const char ***\fIlistptr\fR);"  .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
14    .
15  .SH DESCRIPTION  .SH DESCRIPTION
16  .rs  .rs
17  .sp  .sp
18  This is a convenience function for extracting a list of all the captured  This is a convenience function for extracting a list of all the captured
19  substrings. The arguments are:  substrings. The arguments are:
20    .sp
21    \fIsubject\fR       Subject that has been successfully matched    \fIsubject\fP       Subject that has been successfully matched
22    \fIovector\fR       Offset vector that \fBpcre_exec\fR used    \fIovector\fP       Offset vector that \fBpcre_exec\fP used
23    \fIstringcount\fR   Value returned by \fBpcre_exec\fR    \fIstringcount\fP   Value returned by \fBpcre_exec\fP
24    \fIlistptr\fR       Where to put a pointer to the list    \fIlistptr\fP       Where to put a pointer to the list
25    .sp
26  The yield is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could  The memory in which the substrings and the list are placed is obtained by
27  not be obtained.  calling \fBpcre_malloc()\fP. A pointer to a list of pointers is put in
28    the variable whose address is in \fIlistptr\fP. The list is terminated by a
29  There is a complete description of the PCRE API in the  NULL pointer. The yield of the function is zero on success or
30    PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained.
31    .P
32    There is a complete description of the PCRE native API in the
33    .\" HREF
34    \fBpcreapi\fP
35    .\"
36    page and a description of the POSIX API in the
37  .\" HREF  .\" HREF
38  \fBpcreapi\fR  \fBpcreposix\fP
39  .\"  .\"
40  page.  page.
Legend:
Removed from v.63  
changed lines
  Added in v.75
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12