new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_code_copy_with_tables.3
1 .TH PCRE2_CODE_COPY 3 "22 November 2016" "PCRE2 10.23"
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 pcre2_code *pcre2_code_copy_with_tables(const pcre2_code *\fIcode\fP);
11 .fi
12 .
13 .SH DESCRIPTION
14 .rs
15 .sp
16 This function makes a copy of the memory used for a compiled pattern, excluding
17 any memory used by the JIT compiler. Without a subsequent call to
18 \fBpcre2_jit_compile()\fP, the copy can be used only for non-JIT matching.
19 Unlike \fBpcre2_code_copy()\fP, a separate copy of the character tables is also
20 made, with the new code pointing to it. This memory will be automatically freed
21 when \fBpcre2_code_free()\fP is called. The yield of the function is NULL if
22 \fIcode\fP is NULL or if sufficient memory cannot be obtained.
23 .P
24 There is a complete description of the PCRE2 native API in the
25 .\" HREF
26 \fBpcre2api\fP
27 .\"
28 page and a description of the POSIX API in the
29 .\" HREF
30 \fBpcre2posix\fP
31 .\"
32 page.