1<html>
2<head><title>smfi_setpriv</title></head>
3<body>
| 1<HTML>
2<HEAD><TITLE>smfi_setpriv</TITLE></HEAD>
3<BODY>
|
4<!--
| 4<!--
|
5$Id: smfi_setpriv.html,v 1.9 2003/03/05 19:57:54 ca Exp $
| 5$Id: smfi_setpriv.html,v 1.11 2006/12/21 18:30:35 ca Exp $
|
6-->
| 6-->
|
7<h1>smfi_setpriv</h1>
| 7<H1>smfi_setpriv</H1>
|
8
| 8
|
9<table border="0" cellspacing=4 cellpadding=4>
| 9<TABLE border="0" cellspacing=4 cellpadding=4>
|
10<!---------- Synopsis ----------->
| 10<!---------- Synopsis ----------->
|
11<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
12<pre>
| 11<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD>
12<PRE>
|
13#include <libmilter/mfapi.h>
14int smfi_setpriv(
15 SMFICTX *ctx,
16 void *privatedata
17);
| 13#include <libmilter/mfapi.h>
14int smfi_setpriv(
15 SMFICTX *ctx,
16 void *privatedata
17);
|
18</pre>
| 18</PRE>
|
19Set the private data pointer for this connection.
| 19Set the private data pointer for this connection.
|
20</td></tr>
| 20</TD></TR>
|
21
22<!----------- Description ---------->
| 21
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>
28</tr>
29<tr align="left" valign=top>
30<th width="80">Effects</th>
31<td>Sets the private data pointer for the context ctx.</td>
32</tr>
33</table>
| 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>
28</TR>
29<TR align="left" valign=top>
30<TH width="80">Effects</TH>
31<TD>Sets the private data pointer for the context ctx.</TD>
32</TR>
33</TABLE>
|
34
35<!----------- Arguments ---------->
| 34
35<!----------- Arguments ---------->
|
36<tr><th valign="top" align=left>ARGUMENTS</th><td>
37 <table border="1" cellspacing=0>
38 <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
39 <tr valign="top"><td>ctx</td>
40 <td>Opaque context structure.
41 </td></tr>
42 <tr valign="top"><td>privatedata</td>
43 <td>Pointer to private data. This value will be returned by subsequent calls to <a href="smfi_getpriv.html">smfi_getpriv</a> using ctx.
44 </td></tr>
45 </table>
46</td></tr>
| 36<TR><TH valign="top" align=left>ARGUMENTS</TH><TD>
37 <TABLE border="1" cellspacing=0>
38 <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
39 <TR valign="top"><TD>ctx</TD>
40 <TD>Opaque context structure.
41 </TD></TR>
42 <TR valign="top"><TD>privatedata</TD>
43 <TD>Pointer to private data. This value will be returned by subsequent calls to <A href="smfi_getpriv.html">smfi_getpriv</A> using ctx.
44 </TD></TR>
45 </TABLE>
46</TD></TR>
|
47
48<!----------- Return values ---------->
| 47
48<!----------- Return values ---------->
|
49<tr>
50<th valign="top" align=left>RETURN VALUES</th>
| 49<TR>
50<TH valign="top" align=left>RETURN VALUES</TH>
|
51
| 51
|
52<td>smfi_setpriv returns MI_FAILURE if ctx is an invalid context.
53Otherwise, it returns MI_SUCCESS.</td>
54</tr>
| 52<TD>smfi_setpriv returns MI_FAILURE if ctx is an invalid context.
53Otherwise, it returns MI_SUCCESS.</TD>
54</TR>
|
55
| 55
|
56<tr>
57<th valign="top" align=left>NOTES</th>
| 56<TR>
57<TH valign="top" align=left>NOTES</TH>
|
58
| 58
|
59<td>There is only one private data pointer per connection; multiple
| 59<TD>There is only one private data pointer per connection; multiple
|
60calls to smfi_setpriv with different values will cause previous values
61to be lost.
62<P>
63Before a filter terminates it should release the private data
64and set the pointer to NULL.
| 60calls to smfi_setpriv with different values will cause previous values
61to be lost.
62<P>
63Before a filter terminates it should release the private data
64and set the pointer to NULL.
|
65</td>
| 65</TD>
|
66
| 66
|
67</tr>
| 67</TR>
|
68
| 68
|
69</table>
| 69</TABLE>
|
70
| 70
|
71<hr size="1">
72<font size="-1">
| 71<HR size="1">
72<FONT size="-1">
|
73Copyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
74All rights reserved.
| 73Copyright (c) 2000-2001, 2003 Sendmail, Inc. and its suppliers.
74All rights reserved.
|
75<br>
| 75<BR>
|
76By using this file, you agree to the terms and conditions set
77forth in the LICENSE.
| 76By using this file, you agree to the terms and conditions set
77forth in the LICENSE.
|
78</font>
79</body>
80</html>
| 78</FONT>
79</BODY>
80</HTML>
|
| |