xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_version.html (revision d0cef73d40a409e3116f095b83633b1364e95741)
1d0cef73dSGregory Neil Shapiro<HTML>
2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_version()</TITLE></HEAD>
3d0cef73dSGregory Neil Shapiro<BODY>
4d0cef73dSGregory Neil Shapiro<!--
5d0cef73dSGregory Neil Shapiro$Id: smfi_version.html,v 1.5 2007/03/22 17:30:57 ca Exp $
6d0cef73dSGregory Neil Shapiro-->
7d0cef73dSGregory Neil Shapiro<H1>smfi_version()</H1>
8d0cef73dSGregory Neil Shapiro
9d0cef73dSGregory Neil Shapiro<TABLE BORDER="0" CELLSPACING=4 CELLPADDING=4>
10d0cef73dSGregory Neil Shapiro<!---------- Synopsis ----------->
11d0cef73dSGregory Neil Shapiro<TR><TH VALIGN="TOP" ALIGN=LEFT WIDTH=100>SYNOPSIS</TH><TD>
12d0cef73dSGregory Neil Shapiro<PRE>
13d0cef73dSGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
14d0cef73dSGregory Neil Shapiroint smfi_version(
15d0cef73dSGregory Neil Shapiro	unsigned int *pmajor,
16d0cef73dSGregory Neil Shapiro	unsigned int *pminor,
17d0cef73dSGregory Neil Shapiro	unsigned int *ppl
18d0cef73dSGregory Neil Shapiro);
19d0cef73dSGregory Neil Shapiro</PRE>
20d0cef73dSGregory Neil ShapiroGet the (runtime) version of libmilter.
21d0cef73dSGregory Neil Shapiro</TD></TR>
22d0cef73dSGregory Neil Shapiro
23d0cef73dSGregory Neil Shapiro<!----------- Description ---------->
24d0cef73dSGregory Neil Shapiro<TR><TH VALIGN="TOP" ALIGN=LEFT>DESCRIPTION</TH><TD>
25d0cef73dSGregory Neil Shapiro<TABLE BORDER="1" CELLSPACING=1 CELLPADDING=4>
26d0cef73dSGregory Neil Shapiro<TR ALIGN="LEFT" VALIGN=TOP>
27d0cef73dSGregory Neil Shapiro<TH WIDTH="80">Called When</TH>
28d0cef73dSGregory Neil Shapiro<TD>smfi_version may be called at any time.</TD>
29d0cef73dSGregory Neil Shapiro</TR>
30d0cef73dSGregory Neil Shapiro<TR ALIGN="LEFT" VALIGN=TOP>
31d0cef73dSGregory Neil Shapiro<TH WIDTH="80">Effects</TH>
32d0cef73dSGregory Neil Shapiro<TD>None.</TD>
33d0cef73dSGregory Neil Shapiro</TR>
34d0cef73dSGregory Neil Shapiro</TABLE>
35d0cef73dSGregory Neil Shapiro
36d0cef73dSGregory Neil Shapiro<!----------- Arguments ---------->
37d0cef73dSGregory Neil Shapiro<TR><TH VALIGN="TOP" ALIGN=LEFT>ARGUMENTS</TH><TD>
38d0cef73dSGregory Neil Shapiro    <TABLE BORDER="1" CELLSPACING=0>
39d0cef73dSGregory Neil Shapiro    <TR BGCOLOR="#dddddd"><TH>Argument</TH><TH>Description</TH></TR>
40d0cef73dSGregory Neil Shapiro    <TR VALIGN="TOP"><TD>pmajor</TD>
41d0cef73dSGregory Neil Shapiro	<TD>Pointer to an unsigned int variable to store major version number.
42d0cef73dSGregory Neil Shapiro	</TD></TR>
43d0cef73dSGregory Neil Shapiro    <TR VALIGN="TOP"><TD>pminor</TD>
44d0cef73dSGregory Neil Shapiro	<TD>Pointer to an unsigned int variable to store minor version number.
45d0cef73dSGregory Neil Shapiro	</TD></TR>
46d0cef73dSGregory Neil Shapiro    <TR VALIGN="TOP"><TD>ppl</TD>
47d0cef73dSGregory Neil Shapiro	<TD>Pointer to an unsigned int variable to store patch level number.
48d0cef73dSGregory Neil Shapiro	</TD></TR>
49d0cef73dSGregory Neil Shapiro    </TABLE>
50d0cef73dSGregory Neil Shapiro</TD></TR>
51d0cef73dSGregory Neil Shapiro
52d0cef73dSGregory Neil Shapiro<!----------- Return values ---------->
53d0cef73dSGregory Neil Shapiro<TR>
54d0cef73dSGregory Neil Shapiro<TH VALIGN="TOP" ALIGN=LEFT>RETURN VALUES</TH>
55d0cef73dSGregory Neil Shapiro<TD>smfi_version returns MI_SUCCESS.</TD>
56d0cef73dSGregory Neil Shapiro</TR>
57d0cef73dSGregory Neil Shapiro
58d0cef73dSGregory Neil Shapiro</TABLE>
59d0cef73dSGregory Neil Shapiro
60d0cef73dSGregory Neil ShapiroNote: the compile time version of libmilter is available in the macro
61d0cef73dSGregory Neil Shapiro<CODE>SMFI_VERSION</CODE>.
62d0cef73dSGregory Neil ShapiroA milter can check this macro to determine which functions to use
63d0cef73dSGregory Neil Shapiro(at compile time via C preprocessor statements).
64d0cef73dSGregory Neil ShapiroUsing this macro and the
65d0cef73dSGregory Neil Shapiro<CODE>smfi_version()</CODE>
66d0cef73dSGregory Neil Shapirofunction,
67d0cef73dSGregory Neil Shapiroa milter can determine at runtime whether it has been (dynamically)
68d0cef73dSGregory Neil Shapirolinked against the expected libmilter version.
69d0cef73dSGregory Neil ShapiroTo extract the major and minor version as well as the current patch level
70d0cef73dSGregory Neil Shapirofrom this macro, the macros
71d0cef73dSGregory Neil Shapiro<CODE>SM_LM_VRS_MAJOR(v)</CODE>,
72d0cef73dSGregory Neil Shapiro<CODE>SM_LM_VRS_MINOR(v)</CODE>, and
73d0cef73dSGregory Neil Shapiro<CODE>SM_LM_VRS_PLVL(v)</CODE>
74d0cef73dSGregory Neil Shapirocan be used, respectively.
75d0cef73dSGregory Neil Shapiro
76d0cef73dSGregory Neil Shapiro
77d0cef73dSGregory Neil Shapiro<HR SIZE="1">
78d0cef73dSGregory Neil Shapiro<FONT SIZE="-1">
79d0cef73dSGregory Neil ShapiroCopyright (c) 2006, 2007 Sendmail, Inc. and its suppliers.
80d0cef73dSGregory Neil ShapiroAll rights reserved.
81d0cef73dSGregory Neil Shapiro<BR>
82d0cef73dSGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
83d0cef73dSGregory Neil Shapiroforth in the LICENSE.
84d0cef73dSGregory Neil Shapiro</FONT>
85d0cef73dSGregory Neil Shapiro</BODY>
86d0cef73dSGregory Neil Shapiro</HTML>
87