Updates to the README and some documentation (#681)

This commit is contained in:
Nicholas Wilson
2025-02-01 15:50:20 +00:00
committed by GitHub
parent ec7f0a708b
commit 1fffb0d44e
117 changed files with 3812 additions and 3802 deletions

View File

@@ -15,17 +15,17 @@ please consult the man page, in case the conversion went wrong.
<br><b>
SYNOPSIS
</b><br>
<P>
<p>
<b>#include &#60;pcre2.h&#62;</b>
</P>
<P>
</p>
<p>
<b>pcre2_match_data *pcre2_match_data_create(uint32_t <i>ovecsize</i>,</b>
<b> pcre2_general_context *<i>gcontext</i>);</b>
</P>
</p>
<br><b>
DESCRIPTION
</b><br>
<P>
<p>
This function creates a new match data block, which is used for holding the
result of a match. The first argument specifies the number of pairs of offsets
that are required. These form the "output vector" (ovector) within the match
@@ -33,13 +33,13 @@ data block, and are used to identify the matched string and any captured
substrings when matching with <b>pcre2_match()</b>, or a number of different
matches at the same point when used with <b>pcre2_dfa_match()</b>. There is
always one pair of offsets; if <b>ovecsize</b> is zero, it is treated as one.
</P>
<P>
</p>
<p>
The second argument points to a general context, for custom memory management,
or is NULL for system memory management. The result of the function is NULL if
the memory for the block could not be obtained.
</P>
<P>
</p>
<p>
There is a complete description of the PCRE2 native API in the
<a href="pcre2api.html"><b>pcre2api</b></a>
page and a description of the POSIX API in the