xref: /aosp_15_r20/external/pcre/doc/html/pcre2_set_substitute_callout.html (revision 22dc650d8ae982c6770746019a6f94af92b0f024)
1<html>
2<head>
3<title>pcre2_set_substitute_callout specification</title>
4</head>
5<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6<h1>pcre2_set_substitute_callout man page</h1>
7<p>
8Return to the <a href="index.html">PCRE2 index page</a>.
9</p>
10<p>
11This page is part of the PCRE2 HTML documentation. It was generated
12automatically from the original man page. If there is any nonsense in it,
13please consult the man page, in case the conversion went wrong.
14<br>
15<br><b>
16SYNOPSIS
17</b><br>
18<P>
19<b>#include &#60;pcre2.h&#62;</b>
20</P>
21<P>
22<b>int pcre2_set_substitute_callout(pcre2_match_context *<i>mcontext</i>,</b>
23<b>  int (*<i>callout_function</i>)(pcre2_substitute_callout_block *),</b>
24<b>  void *<i>callout_data</i>);</b>
25</P>
26<br><b>
27DESCRIPTION
28</b><br>
29<P>
30This function sets the substitute callout fields in a match context (the first
31argument). The second argument specifies a callout function, and the third
32argument is an opaque data item that is passed to it. The result of this
33function is always zero.
34</P>
35<P>
36There is a complete description of the PCRE2 native API in the
37<a href="pcre2api.html"><b>pcre2api</b></a>
38page and a description of the POSIX API in the
39<a href="pcre2posix.html"><b>pcre2posix</b></a>
40page.
41<p>
42Return to the <a href="index.html">PCRE2 index page</a>.
43</p>
44