xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_setpriv.html (revision 4313cc83440a39bdf976f955b1d4d3f3c4d1552f)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_setpriv</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4e92d3f3fSGregory Neil Shapiro<!--
5*4313cc83SGregory Neil Shapiro$Id: smfi_setpriv.html,v 1.12 2013-11-22 20:51:39 ca Exp $
6e92d3f3fSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>smfi_setpriv</H1>
840266059SGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4>
1040266059SGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
1340266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1440266059SGregory Neil Shapiroint smfi_setpriv(
1540266059SGregory Neil Shapiro	SMFICTX *ctx,
1640266059SGregory Neil Shapiro	void *privatedata
1740266059SGregory Neil Shapiro);
18d0cef73dSGregory Neil Shapiro</PRE>
1940266059SGregory Neil ShapiroSet the private data pointer for this connection.
20d0cef73dSGregory Neil Shapiro</TD></TR>
2140266059SGregory Neil Shapiro
2240266059SGregory Neil Shapiro<!----------- Description ---------->
23d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD>
24d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4>
25d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
26d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH>
27d0cef73dSGregory Neil Shapiro<TD>smfi_setpriv may be called in any of the xxfi_* callbacks.</TD>
28d0cef73dSGregory Neil Shapiro</TR>
29d0cef73dSGregory Neil Shapiro<TR align="left" valign=top>
30d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH>
31d0cef73dSGregory Neil Shapiro<TD>Sets the private data pointer for the context ctx.</TD>
32d0cef73dSGregory Neil Shapiro</TR>
33d0cef73dSGregory Neil Shapiro</TABLE>
3440266059SGregory Neil Shapiro
3540266059SGregory Neil Shapiro<!----------- Arguments ---------->
36d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
37d0cef73dSGregory Neil Shapiro    <TABLE border="1" cellspacing=0>
38d0cef73dSGregory Neil Shapiro    <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
39d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>ctx</TD>
40d0cef73dSGregory Neil Shapiro	<TD>Opaque context structure.
41d0cef73dSGregory Neil Shapiro	</TD></TR>
42d0cef73dSGregory Neil Shapiro    <TR valign="top"><TD>privatedata</TD>
43d0cef73dSGregory 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.
44d0cef73dSGregory Neil Shapiro	</TD></TR>
45d0cef73dSGregory Neil Shapiro    </TABLE>
46d0cef73dSGregory Neil Shapiro</TD></TR>
4740266059SGregory Neil Shapiro
4840266059SGregory Neil Shapiro<!----------- Return values ---------->
49d0cef73dSGregory Neil Shapiro<TR>
50d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH>
5140266059SGregory Neil Shapiro
52d0cef73dSGregory Neil Shapiro<TD>smfi_setpriv returns MI_FAILURE if ctx is an invalid context.
53d0cef73dSGregory Neil ShapiroOtherwise, it returns MI_SUCCESS.</TD>
54d0cef73dSGregory Neil Shapiro</TR>
5540266059SGregory Neil Shapiro
56d0cef73dSGregory Neil Shapiro<TR>
57d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>NOTES</TH>
5840266059SGregory Neil Shapiro
59d0cef73dSGregory Neil Shapiro<TD>There is only one private data pointer per connection; multiple
6040266059SGregory Neil Shapirocalls to smfi_setpriv with different values will cause previous values
6140266059SGregory Neil Shapiroto be lost.
6240266059SGregory Neil Shapiro<P>
6340266059SGregory Neil ShapiroBefore a filter terminates it should release the private data
6440266059SGregory Neil Shapiroand set the pointer to NULL.
65d0cef73dSGregory Neil Shapiro</TD>
6640266059SGregory Neil Shapiro
67d0cef73dSGregory Neil Shapiro</TR>
6840266059SGregory Neil Shapiro
69d0cef73dSGregory Neil Shapiro</TABLE>
7040266059SGregory Neil Shapiro
71d0cef73dSGregory Neil Shapiro<HR size="1">
72d0cef73dSGregory Neil Shapiro<FONT size="-1">
735dd76dd0SGregory Neil ShapiroCopyright (c) 2000-2001, 2003 Proofpoint, Inc. and its suppliers.
7440266059SGregory Neil ShapiroAll rights reserved.
75d0cef73dSGregory Neil Shapiro<BR>
7640266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
775ef517c0SGregory Neil Shapiroforth in the LICENSE.
78d0cef73dSGregory Neil Shapiro</FONT>
79d0cef73dSGregory Neil Shapiro</BODY>
80d0cef73dSGregory Neil Shapiro</HTML>
81