/[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 867 by ph10, Tue Mar 6 12:27:42 2007 UTC revision 868 by ph10, Fri Jan 13 17:16:32 2012 UTC
# Line 10  PCRE - Perl-compatible regular expressio Line 10  PCRE - Perl-compatible regular expressio
10  .B int pcre_get_substring_list(const char *\fIsubject\fP,  .B int pcre_get_substring_list(const char *\fIsubject\fP,
11  .ti +5n  .ti +5n
12  .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"  .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);"
17  .  .
18  .SH DESCRIPTION  .SH DESCRIPTION
19  .rs  .rs
# Line 18  This is a convenience function for extra Line 22  This is a convenience function for extra
22  substrings. The arguments are:  substrings. The arguments are:
23  .sp  .sp
24    \fIsubject\fP       Subject that has been successfully matched    \fIsubject\fP       Subject that has been successfully matched
25    \fIovector\fP       Offset vector that \fBpcre_exec\fP used    \fIovector\fP       Offset vector that \fBpcre[16]_exec\fP used
26    \fIstringcount\fP   Value returned by \fBpcre_exec\fP    \fIstringcount\fP   Value returned by \fBpcre[16]_exec\fP
27    \fIlistptr\fP       Where to put a pointer to the list    \fIlistptr\fP       Where to put a pointer to the list
28  .sp  .sp
29  The memory in which the substrings and the list are placed is obtained by  The memory in which the substrings and the list are placed is obtained by
30  calling \fBpcre_malloc()\fP. The convenience function  calling \fBpcre[16]_malloc()\fP. The convenience function
31  \fBpcre_free_substring_list()\fP can be used to free it when it is no longer  \fBpcre[16]_free_substring_list()\fP can be used to free it when it is no
32  needed. A pointer to a list of pointers is put in the variable whose address is  longer needed. A pointer to a list of pointers is put in the variable whose
33  in \fIlistptr\fP. The list is terminated by a NULL pointer. The yield of the  address is in \fIlistptr\fP. The list is terminated by a NULL pointer. The
34  function is zero on success or PCRE_ERROR_NOMEMORY if sufficient memory could  yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient
35  not be obtained.  memory could not be obtained.
36  .P  .P
37  There is a complete description of the PCRE native API in the  There is a complete description of the PCRE native API in the
38  .\" HREF  .\" HREF
Legend:
Removed from v.867  
changed lines
  Added in v.868
webmaster@exim.org
 ViewVC Help
Powered by ViewVC 1.1.12