new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_set_max_pattern_length.3
1 .TH PCRE2_SET_MAX_PATTERN_LENGTH 3 "05 October 2016" "PCRE2 10.23"
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 int pcre2_set_max_pattern_length(pcre2_compile_context *\fIccontext\fP,
11 .B "  PCRE2_SIZE \fIvalue\fP);"
12 .fi
13 .
14 .SH DESCRIPTION
15 .rs
16 .sp
17 This function sets, in a compile context, the maximum text length (in code
18 units) of the pattern that can be compiled. The result is always zero. If a
19 longer pattern is passed to \fBpcre2_compile()\fP there is an immediate error
20 return. The default is effectively unlimited, being the largest value a
21 PCRE2_SIZE variable can hold.
22 .P
23 There is a complete description of the PCRE2 native API in the
24 .\" HREF
25 \fBpcre2api\fP
26 .\"
27 page and a description of the POSIX API in the
28 .\" HREF
29 \fBpcre2posix\fP
30 .\"
31 page.