contrib/sendmail/libmilter/docs/xxfi_close.html

   1 <html>
   2 <head><title>xxfi_close</title></head>
   3 <body>
   4 <h1>xxfi_close</h1>
   5
   6 <table border="0" cellspacing=4 cellpadding=4>
   7 <!---------- Synopsis ----------->
   8 <tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
   9 <pre>
  10 #include &lt;libmilter/mfapi.h&gt;
  11 sfsistat (*xxfi_close)(
  12         SMFICTX * ctx
  13 );
  14 </pre>
  15 The current connection is being closed.
  16 </td></tr>
  17
  18 <!----------- Description ---------->
  19 <tr><th valign="top" align=left>DESCRIPTION</th><td>
  20 <table border="1" cellspacing=1 cellpadding=4>
  21 <tr align="left" valign=top>
  22 <th width="80">Called When</th>
  23 <td>xxfi_close is always called once at the end of each connection.</td>
  24 </tr>
  25 <tr align="left" valign=top>
  26 <th>Default Behavior</th>
  27 <td>Do nothing; return SMFIS_CONTINUE.</td>
  28 </tr>
  29 </table>
  30
  31 <!----------- Arguments ---------->
  32 <tr><th valign="top" align=left>ARGUMENTS</th><td>
  33     <table border="1" cellspacing=0>
  34     <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
  35     <tr valign="top"><td>ctx</td>
  36         <td>Opaque context structure.
  37         </td></tr>
  38     </table>
  39 </td></tr>
  40
  41 <!----------- Notes ---------->
  42 <tr>
  43 <th valign="top" align=left>NOTES</th>
  44 <td>
  45 <ul>
  46 <li>xxfi_close is called on close even if the previous mail
  47 transaction was aborted.
  48 <li>xxfi_close is responsible for freeing any resources allocated on a
  49 per-connection basis.
  50 <li>Since the connection is already closing, the return value is
  51 currently ignored.
  52 </ul>
  53 </td>
  54 </tr>
  55 </table>
  56
  57 <hr size="1">
  58 <font size="-1">
  59 Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
  60 All rights reserved.
  61 <br>
  62 By using this file, you agree to the terms and conditions set
  63 forth in the LICENSE.
  64 </font>
  65 </body>
  66 </html>