78 lines
2.0 KiB
HTML
78 lines
2.0 KiB
HTML
<html>
|
|
<head><title>smfi_setpriv</title></head>
|
|
<body>
|
|
<h1>smfi_setpriv</h1>
|
|
|
|
<table border="0" cellspacing=4 cellpadding=4>
|
|
<!---------- Synopsis ----------->
|
|
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
|
|
<pre>
|
|
#include <libmilter/mfapi.h>
|
|
int smfi_setpriv(
|
|
SMFICTX *ctx,
|
|
void *privatedata
|
|
);
|
|
</pre>
|
|
Set the private data pointer for this connection.
|
|
</td></tr>
|
|
|
|
<!----------- Description ---------->
|
|
<tr><th valign="top" align=left>DESCRIPTION</th><td>
|
|
<table border="1" cellspacing=1 cellpadding=4>
|
|
<tr align="left" valign=top>
|
|
<th width="80">Called When</th>
|
|
<td>smfi_setpriv may be called in any of the xxfi_* callbacks.</td>
|
|
</tr>
|
|
<tr align="left" valign=top>
|
|
<th width="80">Effects</th>
|
|
<td>Sets the private data pointer for the context ctx.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<!----------- Arguments ---------->
|
|
<tr><th valign="top" align=left>ARGUMENTS</th><td>
|
|
<table border="1" cellspacing=0>
|
|
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
|
|
<tr valign="top"><td>ctx</td>
|
|
<td>Opaque context structure.
|
|
</td></tr>
|
|
<tr valign="top"><td>privatedata</td>
|
|
<td>Pointer to private data. This value will be returned by subsequent calls to <a href="smfi_getpriv.html">smfi_getpriv</a> using ctx.
|
|
</td></tr>
|
|
</table>
|
|
</td></tr>
|
|
|
|
<!----------- Return values ---------->
|
|
<tr>
|
|
<th valign="top" align=left>RETURN VALUES</th>
|
|
|
|
<td>smfi_setpriv returns MI_FAILURE if ctx is an invalid context.
|
|
Otherwise, it returns MI_SUCCESS.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th valign="top" align=left>NOTES</th>
|
|
|
|
<td>There is only one private data pointer per connection; multiple
|
|
calls to smfi_setpriv with different values will cause previous values
|
|
to be lost.
|
|
<P>
|
|
Before a filter terminates it should release the private data
|
|
and set the pointer to NULL.
|
|
</td>
|
|
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
<hr size="1">
|
|
<font size="-1">
|
|
Copyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
|
|
All rights reserved.
|
|
<br>
|
|
By using this file, you agree to the terms and conditions set
|
|
forth in the LICENSE.
|
|
</font>
|
|
</body>
|
|
</html>
|