new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_set_bsr.3
1 .TH PCRE2_SET_BSR 3 "22 October 2014" "PCRE2 10.00"
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_bsr(pcre2_compile_context *\fIccontext\fP,
11 .B "  uint32_t \fIvalue\fP);"
12 .fi
13 .
14 .SH DESCRIPTION
15 .rs
16 .sp
17 This function sets the convention for processing \eR within a compile context.
18 The second argument must be one of PCRE2_BSR_ANYCRLF or PCRE2_BSR_UNICODE. The
19 result is zero for success or PCRE2_ERROR_BADDATA if the second argument is
20 invalid.
21 .P
22 There is a complete description of the PCRE2 native API in the
23 .\" HREF
24 \fBpcre2api\fP
25 .\"
26 page and a description of the POSIX API in the
27 .\" HREF
28 \fBpcre2posix\fP
29 .\"
30 page.