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.5

1.1.1.4   misho       1: .TH PCRE_GET_SUBSTRING_LIST 3 "24 June 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
1.1.1.5 ! misho       9: .nf
1.1       misho      10: .B int pcre_get_substring_list(const char *\fIsubject\fP,
1.1.1.5 ! misho      11: .B "     int *\fIovector\fP, int \fIstringcount\fP, const char ***\fIlistptr\fP);"
        !            12: .sp
1.1.1.2   misho      13: .B int pcre16_get_substring_list(PCRE_SPTR16 \fIsubject\fP,
1.1.1.5 ! misho      14: .B "     int *\fIovector\fP, int \fIstringcount\fP, PCRE_SPTR16 **\fIlistptr\fP);"
        !            15: .sp
1.1.1.4   misho      16: .B int pcre32_get_substring_list(PCRE_SPTR32 \fIsubject\fP,
1.1.1.5 ! misho      17: .B "     int *\fIovector\fP, int \fIstringcount\fP, PCRE_SPTR32 **\fIlistptr\fP);"
        !            18: .fi
1.1       misho      19: .
                     20: .SH DESCRIPTION
                     21: .rs
                     22: .sp
                     23: This is a convenience function for extracting a list of all the captured
                     24: substrings. The arguments are:
                     25: .sp
                     26:   \fIsubject\fP       Subject that has been successfully matched
1.1.1.4   misho      27:   \fIovector\fP       Offset vector that \fBpcre[16|32]_exec\fP used
                     28:   \fIstringcount\fP   Value returned by \fBpcre[16|32]_exec\fP
1.1       misho      29:   \fIlistptr\fP       Where to put a pointer to the list
                     30: .sp
                     31: The memory in which the substrings and the list are placed is obtained by
1.1.1.4   misho      32: calling \fBpcre[16|32]_malloc()\fP. The convenience function
                     33: \fBpcre[16|32]_free_substring_list()\fP can be used to free it when it is no
1.1.1.2   misho      34: longer needed. A pointer to a list of pointers is put in the variable whose
                     35: address is in \fIlistptr\fP. The list is terminated by a NULL pointer. The
                     36: yield of the function is zero on success or PCRE_ERROR_NOMEMORY if sufficient
                     37: memory could not be obtained.
1.1       misho      38: .P
                     39: There is a complete description of the PCRE native API in the
                     40: .\" HREF
                     41: \fBpcreapi\fP
                     42: .\"
                     43: page and a description of the POSIX API in the
                     44: .\" HREF
                     45: \fBpcreposix\fP
                     46: .\"
                     47: page.