src/external/pcre2-10.32/doc/pcre2_match_data_create.3

   1 .TH PCRE2_MATCH_DATA_CREATE 3 "29 July 2015" "PCRE2 10.21"
   2 .SH NAME
   3 PCRE2 - Perl-compatible regular expressions (revised API)
   4 .SH SYNOPSIS
   5 .rs
   6 .sp
   7 .B #include <pcre2.h>
   8 .PP
   9 .nf
  10 .B pcre2_match_data *pcre2_match_data_create(uint32_t \fIovecsize\fP,
  11 .B "  pcre2_general_context *\fIgcontext\fP);"
  12 .fi
  13 .
  14 .SH DESCRIPTION
  15 .rs
  16 .sp
  17 This function creates a new match data block, which is used for holding the
  18 result of a match. The first argument specifies the number of pairs of offsets
  19 that are required. These form the "output vector" (ovector) within the match
  20 data block, and are used to identify the matched string and any captured
  21 substrings. There is always one pair of offsets; if \fBovecsize\fP is zero, it
  22 is treated as one.
  23 .P
  24 The second argument points to a general context, for custom memory management,
  25 or is NULL for system memory management. The result of the function is NULL if
  26 the memory for the block could not be obtained.
  27 .P
  28 There is a complete description of the PCRE2 native API in the
  29 .\" HREF
  30 \fBpcre2api\fP
  31 .\"
  32 page and a description of the POSIX API in the
  33 .\" HREF
  34 \fBpcre2posix\fP
  35 .\"
  36 page.