xref: /aosp_15_r20/external/pcre/doc/html/pcre2_match_data_create_from_pattern.html (revision 22dc650d8ae982c6770746019a6f94af92b0f024)
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>
8Return to the <a href="index.html">PCRE2 index page</a>.
9</p>
10<p>
11This page is part of the PCRE2 HTML documentation. It was generated
12automatically from the original man page. If there is any nonsense in it,
13please consult the man page, in case the conversion went wrong.
14<br>
15<br><b>
16SYNOPSIS
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>
26DESCRIPTION
27</b><br>
28<P>
29This function creates a new match data block for holding the result of a match.
30The first argument points to a compiled pattern. The number of capturing
31parentheses within the pattern is used to compute the number of pairs of
32offsets that are required in the match data block. These form the "output
33vector" (ovector) within the match data block, and are used to identify the
34matched string and any captured substrings when matching with
35<b>pcre2_match()</b>. If you are using <b>pcre2_dfa_match()</b>, which uses the
36output vector in a different way, you should use <b>pcre2_match_data_create()</b>
37instead of this function.
38</P>
39<P>
40The second argument points to a general context, for custom memory management,
41or is NULL to use the same memory allocator as was used for the compiled
42pattern. The result of the function is NULL if the memory for the block could
43not be obtained.
44</P>
45<P>
46There is a complete description of the PCRE2 native API in the
47<a href="pcre2api.html"><b>pcre2api</b></a>
48page and a description of the POSIX API in the
49<a href="pcre2posix.html"><b>pcre2posix</b></a>
50page.
51<p>
52Return to the <a href="index.html">PCRE2 index page</a>.
53</p>
54