2 <HEAD><TITLE>smfi_setpriv</TITLE></HEAD>
5 $Id: smfi_setpriv.html,v 1.12 2013-11-22 20:51:39 ca Exp $
9 <TABLE border="0" cellspacing=4 cellpadding=4>
10 <!---------- Synopsis ----------->
11 <TR><TH valign="top" align=left width=100>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>
36 <!----------- Arguments ---------->
37 <TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
38 <TABLE border="1" cellspacing=0>
39 <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40 <TR valign="top"><TD>ctx</TD>
41 <TD>Opaque context structure.
43 <TR valign="top"><TD>privatedata</TD>
44 <TD>Pointer to private data. This value will be returned by subsequent calls to <A href="smfi_getpriv.html">smfi_getpriv</A> using ctx.
49 <!----------- Return values ---------->
51 <TH valign="top" align=left>RETURN VALUES</TH>
53 <TD>smfi_setpriv returns MI_FAILURE if ctx is an invalid context.
54 Otherwise, it returns MI_SUCCESS.</TD>
58 <TH valign="top" align=left>NOTES</TH>
60 <TD>There is only one private data pointer per connection; multiple
61 calls to smfi_setpriv with different values will cause previous values
64 Before a filter terminates it should release the private data
65 and set the pointer to NULL.
74 Copyright (c) 2000-2001, 2003 Proofpoint, Inc. and its suppliers.
77 By using this file, you agree to the terms and conditions set