new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_general_context_create.3
1 .TH PCRE2_GENERAL_CONTEXT_CREATE 3 "22 October 2014" "PCRE2 10.00"
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_general_context *pcre2_general_context_create(
11 .B "  void *(*\fIprivate_malloc\fP)(PCRE2_SIZE, void *),"
12 .B "  void (*\fIprivate_free\fP)(void *, void *), void *\fImemory_data\fP);"
13 .fi
14 .
15 .SH DESCRIPTION
16 .rs
17 .sp
18 This function creates and initializes a general context. The arguments define
19 custom memory management functions and a data value that is passed to them when
20 they are called. The \fBprivate_malloc()\fP function is used to get memory for
21 the context. If either of the first two arguments is NULL, the system memory
22 management function is used. The result is NULL if no memory could 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.