new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / html / pcre2_jit_stack_create.html
1 <html>
2 <head>
3 <title>pcre2_jit_stack_create specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre2_jit_stack_create man page</h1>
7 <p>
8 Return to the <a href="index.html">PCRE2 index page</a>.
9 </p>
10 <p>
11 This page is part of the PCRE2 HTML documentation. It was generated
12 automatically from the original man page. If there is any nonsense in it,
13 please consult the man page, in case the conversion went wrong.
14 <br>
15 <br><b>
16 SYNOPSIS
17 </b><br>
18 <P>
19 <b>#include &#60;pcre2.h&#62;</b>
20 </P>
21 <P>
22 <b>pcre2_jit_stack *pcre2_jit_stack_create(PCRE2_SIZE <i>startsize</i>,</b>
23 <b>  PCRE2_SIZE <i>maxsize</i>, pcre2_general_context *<i>gcontext</i>);</b>
24 </P>
25 <br><b>
26 DESCRIPTION
27 </b><br>
28 <P>
29 This function is used to create a stack for use by the code compiled by the JIT
30 compiler. The first two arguments are a starting size for the stack, and a
31 maximum size to which it is allowed to grow. The final argument is a general
32 context, for memory allocation functions, or NULL for standard memory
33 allocation. The result can be passed to the JIT run-time code by calling
34 <b>pcre2_jit_stack_assign()</b> to associate the stack with a compiled pattern,
35 which can then be processed by <b>pcre2_match()</b> or <b>pcre2_jit_match()</b>.
36 A maximum stack size of 512KiB to 1MiB should be more than enough for any
37 pattern. For more details, see the
38 <a href="pcre2jit.html"><b>pcre2jit</b></a>
39 page.
40 </P>
41 <P>
42 There is a complete description of the PCRE2 native API in the
43 <a href="pcre2api.html"><b>pcre2api</b></a>
44 page and a description of the POSIX API in the
45 <a href="pcre2posix.html"><b>pcre2posix</b></a>
46 page.
47 <p>
48 Return to the <a href="index.html">PCRE2 index page</a>.
49 </p>