new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_converted_pattern_free.3
1 .TH PCRE2_CONVERTED_PATTERN_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 .nf
10 .B void pcre2_converted_pattern_free(PCRE2_UCHAR *\fIconverted_pattern\fP);
11 .fi
12 .
13 .SH DESCRIPTION
14 .rs
15 .sp
16 This function is part of an experimental set of pattern conversion functions.
17 It frees the memory occupied by a converted pattern that was obtained by
18 calling \fBpcre2_pattern_convert()\fP with arguments that caused it to place
19 the converted pattern into newly obtained heap memory. If the argument is NULL,
20 the function returns immediately without doing anything.
21 .P
22 The pattern conversion functions are described in the
23 .\" HREF
24 \fBpcre2convert\fP
25 .\"
26 documentation.