2007-04-08 21:38:51 -04:00
|
|
|
<HTML>
|
|
|
|
|
<HEAD><TITLE>smfi_setpriv</TITLE></HEAD>
|
|
|
|
|
<BODY>
|
2004-07-31 21:04:57 -04:00
|
|
|
<!--
|
2007-04-08 21:38:51 -04:00
|
|
|
$Id: smfi_setpriv.html,v 1.11 2006/12/21 18:30:35 ca Exp $
|
2004-07-31 21:04:57 -04:00
|
|
|
-->
|
2007-04-08 21:38:51 -04:00
|
|
|
<H1>smfi_setpriv</H1>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
2007-04-08 21:38:51 -04:00
|
|
|
<TABLE border="0" cellspacing=4 cellpadding=4>
|
2002-02-17 16:56:45 -05:00
|
|
|
<!---------- Synopsis ----------->
|
2007-04-08 21:38:51 -04:00
|
|
|
<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
|
|
|
|
|
<PRE>
|
2002-02-17 16:56:45 -05:00
|
|
|
#include <libmilter/mfapi.h>
|
|
|
|
|
int smfi_setpriv(
|
|
|
|
|
SMFICTX *ctx,
|
|
|
|
|
void *privatedata
|
|
|
|
|
);
|
2007-04-08 21:38:51 -04:00
|
|
|
</PRE>
|
2002-02-17 16:56:45 -05:00
|
|
|
Set the private data pointer for this connection.
|
2007-04-08 21:38:51 -04:00
|
|
|
</TD></TR>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
|
|
|
|
<!----------- Description ---------->
|
2007-04-08 21:38:51 -04:00
|
|
|
<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>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
|
|
|
|
<!----------- Arguments ---------->
|
2007-04-08 21:38:51 -04:00
|
|
|
<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>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
|
|
|
|
<!----------- Return values ---------->
|
2007-04-08 21:38:51 -04:00
|
|
|
<TR>
|
|
|
|
|
<TH valign="top" align=left>RETURN VALUES</TH>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
2007-04-08 21:38:51 -04:00
|
|
|
<TD>smfi_setpriv returns MI_FAILURE if ctx is an invalid context.
|
|
|
|
|
Otherwise, it returns MI_SUCCESS.</TD>
|
|
|
|
|
</TR>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
2007-04-08 21:38:51 -04:00
|
|
|
<TR>
|
|
|
|
|
<TH valign="top" align=left>NOTES</TH>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
2007-04-08 21:38:51 -04:00
|
|
|
<TD>There is only one private data pointer per connection; multiple
|
2002-02-17 16:56:45 -05:00
|
|
|
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.
|
2007-04-08 21:38:51 -04:00
|
|
|
</TD>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
2007-04-08 21:38:51 -04:00
|
|
|
</TR>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
2007-04-08 21:38:51 -04:00
|
|
|
</TABLE>
|
2002-02-17 16:56:45 -05:00
|
|
|
|
2007-04-08 21:38:51 -04:00
|
|
|
<HR size="1">
|
|
|
|
|
<FONT size="-1">
|
2003-03-29 14:12:53 -05:00
|
|
|
Copyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
|
2002-02-17 16:56:45 -05:00
|
|
|
All rights reserved.
|
2007-04-08 21:38:51 -04:00
|
|
|
<BR>
|
2002-02-17 16:56:45 -05:00
|
|
|
By using this file, you agree to the terms and conditions set
|
2003-03-29 14:12:53 -05:00
|
|
|
forth in the LICENSE.
|
2007-04-08 21:38:51 -04:00
|
|
|
</FONT>
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
