smfi_progress.html revision 168516 
1290968Sngie<HTML>
2290968Sngie<HEAD><TITLE>smfi_progress</TITLE></HEAD>
3298107Sgjb<BODY>
4299094Sngie<!--
5293821Sngie$Id: smfi_progress.html,v 1.5 2006/12/21 18:30:35 ca Exp $
6293821Sngie-->
7290968Sngie<H1>smfi_progress</H1>
8290968Sngie
9290968Sngie<TABLE border="0" cellspacing=4 cellpadding=4>
10299094Sngie<!---------- Synopsis ----------->
11290968Sngie<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12293821Sngie<PRE>
13293821Sngie#include &lt;libmilter/mfapi.h&gt;
14293821Sngieint smfi_progress(
15293821Sngie	SMFICTX *ctx;
16290968Sngie);
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