2 <head><title>smfi_setpriv</title></head>
5 $Id: smfi_setpriv.html,v 1.9 2003/03/05 19:57:54 ca Exp $
9 <table border="0" cellspacing=4 cellpadding=4>
10 <!---------- Synopsis ----------->
11 <tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
13 #include <libmilter/mfapi.h>
19 Set the private data pointer for this connection.
22 <!----------- Description ---------->
23 <tr><th valign="top" align=left>DESCRIPTION</th><td>
24 <table border="1" cellspacing=1 cellpadding=4>
25 <tr align="left" valign=top>
26 <th width="80">Called When</th>
27 <td>smfi_setpriv may be called in any of the xxfi_* callbacks.</td>
29 <tr align="left" valign=top>
30 <th width="80">Effects</th>
31 <td>Sets the private data pointer for the context ctx.</td>
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.
42 <tr valign="top"><td>privatedata</td>
43 <td>Pointer to private data. This value will be returned by subsequent calls to <a href="smfi_getpriv.html">smfi_getpriv</a> using ctx.
48 <!----------- Return values ---------->
50 <th valign="top" align=left>RETURN VALUES</th>
52 <td>smfi_setpriv returns MI_FAILURE if ctx is an invalid context.
53 Otherwise, it returns MI_SUCCESS.</td>
57 <th valign="top" align=left>NOTES</th>
59 <td>There is only one private data pointer per connection; multiple
60 calls to smfi_setpriv with different values will cause previous values
63 Before a filter terminates it should release the private data
64 and set the pointer to NULL.
73 Copyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
76 By using this file, you agree to the terms and conditions set