summaryrefslogtreecommitdiff
path: root/doc/pcre2_substring_free.3
diff options
context:
space:
mode:
authorMatthew Vernon <matthew@debian.org>2015-11-22 17:40:07 +0000
committerMatthew Vernon <matthew@debian.org>2015-11-22 17:40:07 +0000
commitc27ff5607e8146d7dcacf9ab7c25a931f14e1fbd (patch)
treec146457ebdc1247ca5b921d74e35e680be1f941a /doc/pcre2_substring_free.3
Imported Upstream version 10.20
Diffstat (limited to 'doc/pcre2_substring_free.3')
-rw-r--r--doc/pcre2_substring_free.328
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/pcre2_substring_free.3 b/doc/pcre2_substring_free.3
new file mode 100644
index 0000000..ca94e78
--- /dev/null
+++ b/doc/pcre2_substring_free.3
@@ -0,0 +1,28 @@
+.TH PCRE2_SUBSTRING_FREE 3 "21 October 2014" "PCRE2 10.00"
+.SH NAME
+PCRE2 - Perl-compatible regular expressions (revised API)
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre2.h>
+.PP
+.SM
+.B void pcre2_substring_free(PCRE2_UCHAR *\fIbuffer\fP);
+.
+.SH DESCRIPTION
+.rs
+.sp
+This is a convenience function for freeing the memory obtained by a previous
+call to \fBpcre2_substring_get_byname()\fP or
+\fBpcre2_substring_get_bynumber()\fP. Its only argument is a pointer to the
+string.
+.P
+There is a complete description of the PCRE2 native API in the
+.\" HREF
+\fBpcre2api\fP
+.\"
+page and a description of the POSIX API in the
+.\" HREF
+\fBpcre2posix\fP
+.\"
+page.