new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_substring_free.3
1 .TH PCRE2_SUBSTRING_FREE 3 "28 June 2018" "PCRE2 10.32"
2 .SH NAME
3 PCRE2 - Perl-compatible regular expressions (revised API)
4 .SH SYNOPSIS
5 .rs
6 .sp
7 .B #include <pcre2.h>
8 .PP
9 .SM
10 .B void pcre2_substring_free(PCRE2_UCHAR *\fIbuffer\fP);
11 .
12 .SH DESCRIPTION
13 .rs
14 .sp
15 This is a convenience function for freeing the memory obtained by a previous
16 call to \fBpcre2_substring_get_byname()\fP or
17 \fBpcre2_substring_get_bynumber()\fP. Its only argument is a pointer to the
18 string. If the argument is NULL, the function does nothing.
19 .P
20 There is a complete description of the PCRE2 native API in the
21 .\" HREF
22 \fBpcre2api\fP
23 .\"
24 page and a description of the POSIX API in the
25 .\" HREF
26 \fBpcre2posix\fP
27 .\"
28 page.