Return to pcre_get_substring_list.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Annotation of embedaddon/pcre/doc/pcre_get_substring_list.3, revision 1.1.1.3

1.1.1.3 ! misho       1: .TH PCRE_GET_SUBSTRING_LIST 3 "13 January 2012" "PCRE 8.30"
1.1       misho       2: .SH NAME
                      3: PCRE - Perl-compatible regular expressions
                      4: .SH SYNOPSIS
                      5: .rs
                      6: .sp
                      7: .B #include <pcre.h>
                      8: .PP
                      9: .SM
                     10: .B int pcre_get_substring_list(const char *\fIsubject\fP,
                     11: .ti +5n
                     12: .B int *\fIovector\fP, int \fIstringcount\fP, "const char ***\fIlistptr\fP);"
1.1.1.2   misho      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);"
1.1       misho      17: .
                     18: .SH DESCRIPTION
                     19: .rs
                     20: .sp
                     21: This is a convenience function for extracting a list of all the captured
                     22: substrings. The arguments are:
                     23: .sp
                     24:   \fIsubject\fP       Subject that has been successfully matched
1.1.1.2   misho      25:   \fIovector\fP       Offset vector that \fBpcre[16]_exec\fP used
                     26:   \fIstringcount\fP   Value returned by \fBpcre[16]_exec\fP
1.1       misho      27:   \fIlistptr\fP       Where to put a pointer to the list
                     28: .sp
                     29: The memory in which the substrings and the list are placed is obtained by
1.1.1.2   misho      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.
1.1       misho      36: .P
                     37: There is a complete description of the PCRE native API in the
                     38: .\" HREF
                     39: \fBpcreapi\fP
                     40: .\"
                     41: page and a description of the POSIX API in the
                     42: .\" HREF
                     43: \fBpcreposix\fP
                     44: .\"
                     45: page.