new upstream release (3.3.0); modify package compatibility for Stretch
[ossec-hids.git] / src / external / pcre2-10.32 / doc / pcre2_set_callout.3
1 .TH PCRE2_SET_CALLOUT 3 "21 March 2017" "PCRE2 10.30"
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_callout(pcre2_match_context *\fImcontext\fP,
11 .B "  int (*\fIcallout_function\fP)(pcre2_callout_block *),"
12 .B "  void *\fIcallout_data\fP);"
13 .fi
14 .
15 .SH DESCRIPTION
16 .rs
17 .sp
18 This function sets the callout fields in a match context (the first argument).
19 The second argument specifies a callout function, and the third argument is an
20 opaque data item that is passed to it. The result of this function is always
21 zero.
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.