smfi_progress.html revision 363466 
1<HTML>
2<HEAD><TITLE>smfi_progress</TITLE></HEAD>
3<BODY>
4<!--
5$Id: smfi_progress.html,v 1.6 2013-11-22 20:51:39 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=100>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</TD></TR>
35
36<!----------- Arguments ---------->
37<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38    <TABLE border="1" cellspacing=0>
39    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40    <TR valign="top"><TD>ctx</TD>
41	<TD>Opaque context structure.
42	</TD></TR>
43    </TABLE>
44</TD></TR>
45
46<!----------- Return values ---------->
47<TR>
48<TH valign="top" align=left>RETURN VALUES</TH>
49
50<TD>smfi_progress will fail and return MI_FAILURE if:
51<UL>
52    <LI>A network error occurs.
53</UL>
54Otherwise, it will return MI_SUCCESS
55</TD>
56</TR>
57
58</TABLE>
59
60<HR size="1">
61<FONT size="-1">
62Copyright (c) 2003 Proofpoint, Inc. and its suppliers.
63All rights reserved.
64<BR>
65By using this file, you agree to the terms and conditions set
66forth in the LICENSE.
67</FONT>
68</BODY>
69</HTML>
70