new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_match_data_create_from_pattern.3
1 .TH PCRE2_MATCH_DATA_CREATE_FROM_PATTERN 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_from_pattern(
11 .B "  const pcre2_code *\fIcode\fP, 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 points to a compiled pattern. The number
19 of capturing parentheses within the pattern is used to compute the number of
20 pairs of offsets that are required in the match data block. These form the
21 "output vector" (ovector) within the match data block, and are used to identify
22 the matched string and any captured substrings.
23 .P
24 The second argument points to a general context, for custom memory management,
25 or is NULL to use the same memory allocator as was used for the compiled
26 pattern. The result of the function is NULL if the memory for the block could
27 not be obtained.
28 .P
29 There is a complete description of the PCRE2 native API in the
30 .\" HREF
31 \fBpcre2api\fP
32 .\"
33 page and a description of the POSIX API in the
34 .\" HREF
35 \fBpcre2posix\fP
36 .\"
37 page.