contrib/sendmail/libmilter/docs/smfi_main.html

   1 <HTML>
   2 <HEAD><TITLE>smfi_main</TITLE></HEAD>
   3 <BODY>
   4 <!--
   5 $Id: smfi_main.html,v 1.10 2013-11-22 20:51:39 ca Exp $
   6 -->
   7 <H1>smfi_main</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_main(
  15 );
  16 </PRE>
  17 Hand control to libmilter event loop.
  18 </TD></TR>
  19
  20 <!----------- Description ---------->
  21 <TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
  22 <TABLE border="1" cellspacing=1 cellpadding=4>
  23 <TR align="left" valign=top>
  24 <TH width="80">Called When</TH>
  25 <TD>smfi_main is called after a filter's initialization is complete.</TD>
  26 </TR>
  27 <TR align="left" valign=top>
  28 <TH width="80">Effects</TH>
  29 <TD>smfi_main hands control to the Milter event loop.</TD>
  30 </TR>
  31 </TABLE>
  32 </TD></TR>
  33
  34 <!----------- Return values ---------->
  35 <TR>
  36 <TH valign="top" align=left>RETURN VALUES</TH>
  37
  38 <TD>smfi_main will return MI_FAILURE if it fails to establish a connection.  This may occur for any of a variety of reasons (e.g. invalid address passed to <A href="smfi_setconn.html">smfi_setconn</A>).  The reason for the failure will be logged.  Otherwise, smfi_main will return MI_SUCCESS.</TD>
  39 </TR>
  40
  41 </TABLE>
  42
  43 <HR size="1">
  44 <FONT size="-1">
  45 Copyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers.
  46 All rights reserved.
  47 <BR>
  48 By using this file, you agree to the terms and conditions set
  49 forth in the LICENSE.
  50 </FONT>
  51 </BODY>
  52 </HTML>