new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / html / pcre2_match_data_create_from_pattern.html
1 <html>
2 <head>
3 <title>pcre2_match_data_create_from_pattern specification</title>
4 </head>
5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6 <h1>pcre2_match_data_create_from_pattern 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_match_data *pcre2_match_data_create_from_pattern(</b>
23 <b>  const pcre2_code *<i>code</i>, pcre2_general_context *<i>gcontext</i>);</b>
24 </P>
25 <br><b>
26 DESCRIPTION
27 </b><br>
28 <P>
29 This function creates a new match data block, which is used for holding the
30 result of a match. The first argument points to a compiled pattern. The number
31 of capturing parentheses within the pattern is used to compute the number of
32 pairs of offsets that are required in the match data block. These form the
33 "output vector" (ovector) within the match data block, and are used to identify
34 the matched string and any captured substrings.
35 </P>
36 <P>
37 The second argument points to a general context, for custom memory management,
38 or is NULL to use the same memory allocator as was used for the compiled
39 pattern. The result of the function is NULL if the memory for the block could
40 not be obtained.
41 </P>
42 <P>
43 There is a complete description of the PCRE2 native API in the
44 <a href="pcre2api.html"><b>pcre2api</b></a>
45 page and a description of the POSIX API in the
46 <a href="pcre2posix.html"><b>pcre2posix</b></a>
47 page.
48 <p>
49 Return to the <a href="index.html">PCRE2 index page</a>.
50 </p>