/[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 1054 by ph10, Sat Mar 31 18:09:26 2012 UTC revision 1055 by chpe, Tue Oct 16 15:53:30 2012 UTC
# Line 1  Line 1 
1  .TH PCRE_GET_SUBSTRING_LIST 3 "13 January 2012" "PCRE 8.30"  .TH PCRE_GET_SUBSTRING_LIST 3 "24 June 2012" "PCRE 8.30"
2  .SH NAME  .SH NAME
3  PCRE - Perl-compatible regular expressions  PCRE - Perl-compatible regular expressions
4  .SH SYNOPSIS  .SH SYNOPSIS
# Line 14  PCRE - Perl-compatible regular expressio Line 14  PCRE - Perl-compatible regular expressio
14  .B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP,  .B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP,
15  .ti +5n  .ti +5n
16  .B int *\fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR16 **\fIlistptr\fP);"  .B int *\fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR16 **\fIlistptr\fP);"
17    .PP
18    .B int pcre32_get_substring_list(PCRE_SPTR32 \fIsubject\fP,
19    .ti +5n
20    .B int *\fIovector\fP, int \fIstringcount\fP, "PCRE_SPTR32 **\fIlistptr\fP);"
21  .  .
22  .SH DESCRIPTION  .SH DESCRIPTION
23  .rs  .rs
# Line 22  This is a convenience function for extra Line 26  This is a convenience function for extra
26  substrings. The arguments are:  substrings. The arguments are:
27  .sp  .sp
28    \fIsubject\fP       Subject that has been successfully matched    \fIsubject\fP       Subject that has been successfully matched
29    \fIovector\fP       Offset vector that \fBpcre[16]_exec\fP used    \fIovector\fP       Offset vector that \fBpcre[16|32]_exec\fP used
30    \fIstringcount\fP   Value returned by \fBpcre[16]_exec\fP    \fIstringcount\fP   Value returned by \fBpcre[16|32]_exec\fP
31    \fIlistptr\fP       Where to put a pointer to the list    \fIlistptr\fP       Where to put a pointer to the list
32  .sp  .sp
33  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
34  calling \fBpcre[16]_malloc()\fP. The convenience function  calling \fBpcre[16|32]_malloc()\fP. The convenience function
35  \fBpcre[16]_free_substring_list()\fP can be used to free it when it is no  \fBpcre[16|32]_free_substring_list()\fP can be used to free it when it is no
36  longer needed. A pointer to a list of pointers is put in the variable whose  longer needed. A pointer to a list of pointers is put in the variable whose
37  address is in \fIlistptr\fP. The list is terminated by a NULL pointer. The  address is in \fIlistptr\fP. The list is terminated by a NULL pointer. The
38  yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient  yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient

Legend:
Removed from v.1054  
changed lines
  Added in v.1055

  ViewVC Help
Powered by ViewVC 1.1.5