summaryrefslogtreecommitdiff
path: root/doc/pcre_free_substring_list.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/pcre_free_substring_list.3')
-rw-r--r--doc/pcre_free_substring_list.331
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/pcre_free_substring_list.3 b/doc/pcre_free_substring_list.3
new file mode 100644
index 0000000..248b4bd
--- /dev/null
+++ b/doc/pcre_free_substring_list.3
@@ -0,0 +1,31 @@
+.TH PCRE_FREE_SUBSTRING_LIST 3 "24 June 2012" "PCRE 8.30"
+.SH NAME
+PCRE - Perl-compatible regular expressions
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre.h>
+.PP
+.SM
+.B void pcre_free_substring_list(const char **\fIstringptr\fP);
+.PP
+.B void pcre16_free_substring_list(PCRE_SPTR16 *\fIstringptr\fP);
+.PP
+.B void pcre32_free_substring_list(PCRE_SPTR32 *\fIstringptr\fP);
+.
+.SH DESCRIPTION
+.rs
+.sp
+This is a convenience function for freeing the store obtained by a previous
+call to \fBpcre[16|32]_get_substring_list()\fP. Its only argument is a pointer to
+the list of string pointers.
+.P
+There is a complete description of the PCRE native API in the
+.\" HREF
+\fBpcreapi\fP
+.\"
+page and a description of the POSIX API in the
+.\" HREF
+\fBpcreposix\fP
+.\"
+page.