contrib/sendmail/libmilter/docs/smfi_progress.html

   1 <HTML>
   2 <HEAD><TITLE>smfi_progress</TITLE></HEAD>
   3 <BODY>
   4 <!--
   5 $Id: smfi_progress.html,v 1.5 2006/12/21 18:30:35 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;
  14 int smfi_progress(
  15         SMFICTX *ctx;
  16 );
  17 </PRE>
  18 Notify 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
  31 on 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>
  53 Otherwise, it will return MI_SUCCESS
  54 </TD>
  55 </TR>
  56
  57 </TABLE>
  58
  59 <HR size="1">
  60 <FONT size="-1">
  61 Copyright (c) 2003 Sendmail, Inc. and its suppliers.
  62 All rights reserved.
  63 <BR>
  64 By using this file, you agree to the terms and conditions set
  65 forth in the LICENSE.
  66 </FONT>
  67 </BODY>
  68 </HTML>