xxfi_abort.html revision 112810 
1<html>
2<head><title>xxfi_abort</title></head>
3<body>
4<h1>xxfi_abort</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;
11sfsistat (*xxfi_abort)(
12	SMFICTX * ctx
13);
14</pre>
15Handle the current message's being aborted.
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_abort may be called at any time during message processing (i.e. between some message-oriented routine and <a href="xxfi_eom.html">xxfi_eom</a>).</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_abort must reclaim any resources allocated on a per-message
47basis, and must be tolerant of being called between any two
48message-oriented callbacks.
49
50<li>Calls to xxfi_abort and <a href="xxfi_eom.html">xxfi_eom</a> are
51mutually exclusive.
52
53<li>xxfi_abort is not responsible for reclaiming connection-specific
54data, since <a href="xxfi_close.html">xxfi_close</a> is always called
55when a connection is closed.
56
57<li>Since the current message is already being aborted, the return
58value is currently ignored.
59
60<li>xxfi_abort is only called if the message is aborted outside the
61filter's control <b>and</b> the filter has not completed its
62message-oriented processing.  For example, if a filter has already
63returned SMFIS_ACCEPT, SMFIS_REJECT, or SMFIS_DISCARD from a
64message-oriented routine, xxfi_abort will not be called even if the
65message is later aborted outside its control.
66</ul>
67</td>
68</tr>
69</table>
70
71<hr size="1">
72<font size="-1">
73Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers.
74All rights reserved.
75<br>
76By using this file, you agree to the terms and conditions set
77forth in the LICENSE.
78</font>
79</body>
80</html>
81