xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_setpriv.html (revision 5ef517c097100c80269c8a0e02678a89fde6b35e)
140266059SGregory Neil Shapiro<html>
240266059SGregory Neil Shapiro<head><title>smfi_setpriv</title></head>
340266059SGregory Neil Shapiro<body>
440266059SGregory Neil Shapiro<h1>smfi_setpriv</h1>
540266059SGregory Neil Shapiro
640266059SGregory Neil Shapiro<table border="0" cellspacing=4 cellpadding=4>
740266059SGregory Neil Shapiro<!---------- Synopsis ----------->
840266059SGregory Neil Shapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
940266059SGregory Neil Shapiro<pre>
1040266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1140266059SGregory Neil Shapiroint smfi_setpriv(
1240266059SGregory Neil Shapiro	SMFICTX *ctx,
1340266059SGregory Neil Shapiro	void *privatedata
1440266059SGregory Neil Shapiro);
1540266059SGregory Neil Shapiro</pre>
1640266059SGregory Neil ShapiroSet the private data pointer for this connection.
1740266059SGregory Neil Shapiro</td></tr>
1840266059SGregory Neil Shapiro
1940266059SGregory Neil Shapiro<!----------- Description ---------->
2040266059SGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
2140266059SGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
2240266059SGregory Neil Shapiro<tr align="left" valign=top>
2340266059SGregory Neil Shapiro<th width="80">Called When</th>
2440266059SGregory Neil Shapiro<td>smfi_setpriv may be called in any of the xxfi_* callbacks.</td>
2540266059SGregory Neil Shapiro</tr>
2640266059SGregory Neil Shapiro<tr align="left" valign=top>
2740266059SGregory Neil Shapiro<th width="80">Effects</th>
2840266059SGregory Neil Shapiro<td>Sets the private data pointer for the context ctx.</td>
2940266059SGregory Neil Shapiro</tr>
3040266059SGregory Neil Shapiro</table>
3140266059SGregory Neil Shapiro
3240266059SGregory Neil Shapiro<!----------- Arguments ---------->
3340266059SGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
3440266059SGregory Neil Shapiro    <table border="1" cellspacing=0>
3540266059SGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
3640266059SGregory Neil Shapiro    <tr valign="top"><td>ctx</td>
3740266059SGregory Neil Shapiro	<td>Opaque context structure.
3840266059SGregory Neil Shapiro	</td></tr>
3940266059SGregory Neil Shapiro    <tr valign="top"><td>privatedata</td>
4040266059SGregory Neil Shapiro	<td>Pointer to private data.  This value will be returned by subsequent calls to <a href="smfi_getpriv.html">smfi_getpriv</a> using ctx.
4140266059SGregory Neil Shapiro	</td></tr>
4240266059SGregory Neil Shapiro    </table>
4340266059SGregory Neil Shapiro</td></tr>
4440266059SGregory Neil Shapiro
4540266059SGregory Neil Shapiro<!----------- Return values ---------->
4640266059SGregory Neil Shapiro<tr>
4740266059SGregory Neil Shapiro<th valign="top" align=left>RETURN VALUES</th>
4840266059SGregory Neil Shapiro
4940266059SGregory Neil Shapiro<td>smfi_setpriv returns MI_FAILURE if ctx is an invalid context.
5040266059SGregory Neil ShapiroOtherwise, it returns MI_SUCCESS.</td>
5140266059SGregory Neil Shapiro</tr>
5240266059SGregory Neil Shapiro
5340266059SGregory Neil Shapiro<tr>
5440266059SGregory Neil Shapiro<th valign="top" align=left>NOTES</th>
5540266059SGregory Neil Shapiro
5640266059SGregory Neil Shapiro<td>There is only one private data pointer per connection; multiple
5740266059SGregory Neil Shapirocalls to smfi_setpriv with different values will cause previous values
5840266059SGregory Neil Shapiroto be lost.
5940266059SGregory Neil Shapiro<P>
6040266059SGregory Neil ShapiroBefore a filter terminates it should release the private data
6140266059SGregory Neil Shapiroand set the pointer to NULL.
6240266059SGregory Neil Shapiro</td>
6340266059SGregory Neil Shapiro
6440266059SGregory Neil Shapiro</tr>
6540266059SGregory Neil Shapiro
6640266059SGregory Neil Shapiro</table>
6740266059SGregory Neil Shapiro
6840266059SGregory Neil Shapiro<hr size="1">
6940266059SGregory Neil Shapiro<font size="-1">
705ef517c0SGregory Neil ShapiroCopyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
7140266059SGregory Neil ShapiroAll rights reserved.
7240266059SGregory Neil Shapiro<br>
7340266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
745ef517c0SGregory Neil Shapiroforth in the LICENSE.
7540266059SGregory Neil Shapiro</font>
7640266059SGregory Neil Shapiro</body>
7740266059SGregory Neil Shapiro</html>
78