xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_progress.html (revision f0a75d274af375d15b97b830966b99a02b7db911)
1<html>
2<head><title>smfi_progress</title></head>
3<body>
4<!--
5$Id: smfi_progress.html,v 1.3 2003/03/05 19:57:54 ca Exp $
6-->
7<h1>smfi_progress</h1>
8
9<table border="0" cellspacing=4 cellpadding=4>
10<!---------- Synopsis ----------->
11<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12<pre>
13#include &lt;libmilter/mfapi.h&gt;
14int smfi_progress(
15	SMFICTX *ctx;
16);
17</pre>
18Notify the MTA that an operation is still in progress.
19</td></tr>
20
21<!----------- Description ---------->
22<tr><th valign="top" align=left>DESCRIPTION</th><td>
23<table border="1" cellspacing=1 cellpadding=4>
24<tr align="left" valign=top>
25<th width="80">Called When</th>
26<td>Called only from <a href="xxfi_eom.html">xxfi_eom</a>.</td>
27</tr>
28<tr align="left" valign=top>
29<th width="80">Effects</th>
30<td>smfi_progress notifies the MTA that the filter is still working
31on a message, causing the MTA to re-start its timeouts.</td>
32</tr>
33</table>
34
35<!----------- Arguments ---------->
36<tr><th valign="top" align=left>ARGUMENTS</th><td>
37    <table border="1" cellspacing=0>
38    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
39    <tr valign="top"><td>ctx</td>
40	<td>Opaque context structure.
41	</td></tr>
42    </table>
43</td></tr>
44
45<!----------- Return values ---------->
46<tr>
47<th valign="top" align=left>RETURN VALUES</th>
48
49<td>smfi_progress will fail and return MI_FAILURE if:
50<ul>
51    <li>A network error occurs.
52</ul>
53Otherwise, it will return MI_SUCCESS
54</td>
55</tr>
56
57</table>
58
59<hr size="1">
60<font size="-1">
61Copyright (c) 2003 Sendmail, Inc. and its suppliers.
62All rights reserved.
63<br>
64By using this file, you agree to the terms and conditions set
65forth in the LICENSE.
66</font>
67</body>
68</html>
69