xref: /aosp_15_r20/external/pcre/doc/html/pcre2_match_data_create.html (revision 22dc650d8ae982c6770746019a6f94af92b0f024)
1<html>
2<head>
3<title>pcre2_match_data_create specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre2_match_data_create 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(uint32_t <i>ovecsize</i>,</b>
23<b>  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, which is used for holding the
30result of a match. The first argument specifies the number of pairs of offsets
31that are required. These form the "output vector" (ovector) within the match
32data block, and are used to identify the matched string and any captured
33substrings when matching with <b>pcre2_match()</b>, or a number of different
34matches at the same point when used with <b>pcre2_dfa_match()</b>. There is
35always one pair of offsets; if <b>ovecsize</b> is zero, it is treated as one.
36</P>
37<P>
38The second argument points to a general context, for custom memory management,
39or is NULL for system memory management. The result of the function is NULL if
40the memory for the block could not be obtained.
41</P>
42<P>
43There is a complete description of the PCRE2 native API in the
44<a href="pcre2api.html"><b>pcre2api</b></a>
45page and a description of the POSIX API in the
46<a href="pcre2posix.html"><b>pcre2posix</b></a>
47page.
48<p>
49Return to the <a href="index.html">PCRE2 index page</a>.
50</p>
51