740954b9be8d15ad2909a92b35c9b52625ea3f9a
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_maketables.3
1 .TH PCRE2_MAKETABLES 3 "17 April 2017" "PCRE2 10.30"
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 const unsigned char *pcre2_maketables(pcre2_general_context *\fIgcontext\fP);
11 .
12 .SH DESCRIPTION
13 .rs
14 .sp
15 This function builds a set of character tables for character code points that
16 are less than 256. These can be passed to \fBpcre2_compile()\fP in a compile
17 context in order to override the internal, built-in tables (which were either
18 defaulted or made by \fBpcre2_maketables()\fP when PCRE2 was compiled). See the
19 .\" HREF
20 \fBpcre2_set_character_tables()\fP
21 .\"
22 page. You might want to do this if you are using a non-standard locale.
23 .P
24 If the argument is NULL, \fBmalloc()\fP is used to get memory for the tables.
25 Otherwise it must point to a general context, which can supply pointers to a
26 custom memory manager. The function yields a pointer to the tables.
27 .P
28 There is a complete description of the PCRE2 native API in the
29 .\" HREF
30 \fBpcre2api\fP
31 .\"
32 page and a description of the POSIX API in the
33 .\" HREF
34 \fBpcre2posix\fP
35 .\"
36 page.