xref: /aosp_15_r20/external/pcre/doc/html/pcre2_match_data_free.html (revision 22dc650d8ae982c6770746019a6f94af92b0f024)
1<html>
2<head>
3<title>pcre2_match_data_free specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre2_match_data_free 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>void pcre2_match_data_free(pcre2_match_data *<i>match_data</i>);</b>
23</P>
24<br><b>
25DESCRIPTION
26</b><br>
27<P>
28If <i>match_data</i> is NULL, this function does nothing. Otherwise,
29<i>match_data</i> must point to a match data block, which this function frees,
30using the memory freeing function from the general context or compiled pattern
31with which it was created, or <b>free()</b> if that was not set. If the match
32data block was previously passed to <b>pcre2_match()</b>, it will have an
33attached heapframe vector; this is also freed.
34</P>
35<P>
36If the PCRE2_COPY_MATCHED_SUBJECT was used for a successful match using this
37match data block, the copy of the subject that was referenced within the block
38is also freed.
39</P>
40<P>
41There is a complete description of the PCRE2 native API in the
42<a href="pcre2api.html"><b>pcre2api</b></a>
43page and a description of the POSIX API in the
44<a href="pcre2posix.html"><b>pcre2posix</b></a>
45page.
46<p>
47Return to the <a href="index.html">PCRE2 index page</a>.
48</p>
49