new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / html / pcre2_jit_match.html
1 <html>
2 <head>
3 <title>pcre2_jit_match specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre2_jit_match 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>int pcre2_jit_match(const pcre2_code *<i>code</i>, PCRE2_SPTR <i>subject</i>,</b>
23 <b>  PCRE2_SIZE <i>length</i>, PCRE2_SIZE <i>startoffset</i>,</b>
24 <b>  uint32_t <i>options</i>, pcre2_match_data *<i>match_data</i>,</b>
25 <b>  pcre2_match_context *<i>mcontext</i>);</b>
26 </P>
27 <br><b>
28 DESCRIPTION
29 </b><br>
30 <P>
31 This function matches a compiled regular expression that has been successfully
32 processed by the JIT compiler against a given subject string, using a matching
33 algorithm that is similar to Perl's. It is a "fast path" interface to JIT, and
34 it bypasses some of the sanity checks that <b>pcre2_match()</b> applies.
35 Its arguments are exactly the same as for
36 <a href="pcre2_match.html"><b>pcre2_match()</b>.</a>
37 </P>
38 <P>
39 The supported options are PCRE2_NOTBOL, PCRE2_NOTEOL, PCRE2_NOTEMPTY,
40 PCRE2_NOTEMPTY_ATSTART, PCRE2_PARTIAL_HARD, and PCRE2_PARTIAL_SOFT. Unsupported
41 options are ignored. The subject string is not checked for UTF validity.
42 </P>
43 <P>
44 The return values are the same as for <b>pcre2_match()</b> plus
45 PCRE2_ERROR_JIT_BADOPTION if a matching mode (partial or complete) is requested
46 that was not compiled. For details of partial matching, see the
47 <a href="pcre2partial.html"><b>pcre2partial</b></a>
48 page.
49 </P>
50 <P>
51 There is a complete description of the PCRE2 native API in the
52 <a href="pcre2api.html"><b>pcre2api</b></a>
53 page and a description of the JIT API in the
54 <a href="pcre2jit.html"><b>pcre2jit</b></a>
55 page.
56 <p>
57 Return to the <a href="index.html">PCRE2 index page</a>.
58 </p>