<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedataserver-Version-Information">
<refmeta>
<refentrytitle role="top_of_page" id="libedataserver-Version-Information.top_of_page">Version Information</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>Version Information</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="libedataserver-Version-Information.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
extern              const guint <link linkend="eds-major-version">eds_major_version</link>;
extern              const guint <link linkend="eds-minor-version">eds_minor_version</link>;
extern              const guint <link linkend="eds-micro-version">eds_micro_version</link>;
const <link linkend="gchar">gchar</link> *       <link linkend="eds-check-version">eds_check_version</link>                   (<link linkend="guint">guint</link> required_major,
                                                         <link linkend="guint">guint</link> required_minor,
                                                         <link linkend="guint">guint</link> required_micro);
#define             <link linkend="EDS-MAJOR-VERSION--CAPS">EDS_MAJOR_VERSION</link>
#define             <link linkend="EDS-MINOR-VERSION--CAPS">EDS_MINOR_VERSION</link>
#define             <link linkend="EDS-MICRO-VERSION--CAPS">EDS_MICRO_VERSION</link>
#define             <link linkend="EDS-CHECK-VERSION--CAPS">EDS_CHECK_VERSION</link>                   (major,minor,micro)
</synopsis>
</refsynopsisdiv>









<refsect1 id="libedataserver-Version-Information.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="libedataserver-Version-Information.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="eds-major-version" role="variable">
<title>eds_major_version</title>
<indexterm zone="eds-major-version"><primary sortas="eds_major_version">eds_major_version</primary></indexterm><programlisting>extern const guint eds_major_version;
</programlisting>
<para>
The major version number of the Evolution-Data-Server libraries.
(e.g. in Evolution-Data-Server 2.24.1 this is 2.)
</para>
<para>
This variable is in the library, so it represents the EDS library you
have linked against.  Contrast with the EDS_MAJOR_VERSION macro, which
represents the major version of the EDS headers you have included.</para>
<para>
</para></refsect2>
<refsect2 id="eds-minor-version" role="variable">
<title>eds_minor_version</title>
<indexterm zone="eds-minor-version"><primary sortas="eds_minor_version">eds_minor_version</primary></indexterm><programlisting>extern const guint eds_minor_version;
</programlisting>
<para>
The minor version number of the Evolution-Data-Server libraries.
(e.g. in Evolution-Data-Server 2.24.1 this is 24.)
</para>
<para>
This variable is in the library, so it represents the EDS library you
have linked against.  Contrast with the EDS_MINOR_VERSION macro, which
represents the minor version of the EDS headers you have included.</para>
<para>
</para></refsect2>
<refsect2 id="eds-micro-version" role="variable">
<title>eds_micro_version</title>
<indexterm zone="eds-micro-version"><primary sortas="eds_micro_version">eds_micro_version</primary></indexterm><programlisting>extern const guint eds_micro_version;
</programlisting>
<para>
The micro version number of the Evolution-Data-Server libraries.
(e.g. in Evolution-Data-Server 2.24.1 this is 1.)
</para>
<para>
This variable is in the library, so it represents the EDS library you
have linked against.  Contrast with the EDS_MICRO_VERSION macro, which
represents the micro version of the EDS headers you have included.</para>
<para>
</para></refsect2>
<refsect2 id="eds-check-version" role="function" condition="since:2.24">
<title>eds_check_version ()</title>
<indexterm zone="eds-check-version" role="2.24"><primary sortas="eds_check_version">eds_check_version</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       eds_check_version                   (<link linkend="guint">guint</link> required_major,
                                                         <link linkend="guint">guint</link> required_minor,
                                                         <link linkend="guint">guint</link> required_micro);</programlisting>
<para>
Checks that the Evolution-Data-Server library in use is compatible with
the given version.  Generally you would pass in the constants
<link linkend="EDS-MAJOR-VERSION--CAPS"><type>EDS_MAJOR_VERSION</type></link>, <link linkend="EDS-MINOR-VERSION--CAPS"><type>EDS_MINOR_VERSION</type></link>, <link linkend="EDS-MICRO-VERSION--CAPS"><type>EDS_MICRO_VERSION</type></link> as the three
arguments to this function.  That produces a check that the library in
use is compatible with the version of Evolution-Data-Server the
application or module was compiled against.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>required_major</parameter>&#160;:</term>
<listitem><simpara> the required major version
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>required_minor</parameter>&#160;:</term>
<listitem><simpara> the required minor version
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>required_micro</parameter>&#160;:</term>
<listitem><simpara> the required micro version
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="NULL--CAPS"><literal>NULL</literal></link> if the Evolution-Data-Server library is compatible with
the given version, or a string describing the version mismatch.  The
returned string is owned by libedataserver and must not be modified or
freed.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.24</para></refsect2>
<refsect2 id="EDS-MAJOR-VERSION--CAPS" role="macro">
<title>EDS_MAJOR_VERSION</title>
<indexterm zone="EDS-MAJOR-VERSION--CAPS"><primary sortas="EDS_MAJOR_VERSION">EDS_MAJOR_VERSION</primary></indexterm><programlisting>#define EDS_MAJOR_VERSION 2
</programlisting>
<para>
The major version number of the Evolution-Data-Server library.  Like
<link linkend="eds-major-version"><function>eds_major_version()</function></link>, but from the headers used at application compile
time, rather than from the library linked against at application run
time.</para>
<para>
</para></refsect2>
<refsect2 id="EDS-MINOR-VERSION--CAPS" role="macro">
<title>EDS_MINOR_VERSION</title>
<indexterm zone="EDS-MINOR-VERSION--CAPS"><primary sortas="EDS_MINOR_VERSION">EDS_MINOR_VERSION</primary></indexterm><programlisting>#define EDS_MINOR_VERSION 24
</programlisting>
<para>
The minor version number of the Evolution-Data-Server library.  Like
<link linkend="eds-minor-version"><function>eds_minor_version()</function></link>, but from the headers used at application compile
time, rather than from the library linked against at application run
time.</para>
<para>
</para></refsect2>
<refsect2 id="EDS-MICRO-VERSION--CAPS" role="macro">
<title>EDS_MICRO_VERSION</title>
<indexterm zone="EDS-MICRO-VERSION--CAPS"><primary sortas="EDS_MICRO_VERSION">EDS_MICRO_VERSION</primary></indexterm><programlisting>#define EDS_MICRO_VERSION 1
</programlisting>
<para>
The micro version number of the Evolution-Data-Server library.  Like
<link linkend="eds-micro-version"><function>eds_micro_version()</function></link>, but from the headers used at application compile
time, rather than from the library linked against at application run
time.</para>
<para>
</para></refsect2>
<refsect2 id="EDS-CHECK-VERSION--CAPS" role="macro">
<title>EDS_CHECK_VERSION()</title>
<indexterm zone="EDS-CHECK-VERSION--CAPS"><primary sortas="EDS_CHECK_VERSION">EDS_CHECK_VERSION</primary></indexterm><programlisting>#define             EDS_CHECK_VERSION(major,minor,micro)</programlisting>
<para>
Checks the version of the Evolution-Data-Server library.  Returns
<link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the version of the EDS header files is the same as or newer
than the passed-in version.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>major</parameter>&#160;:</term>
<listitem><simpara> the major version number
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>minor</parameter>&#160;:</term>
<listitem><simpara> the minor version number
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>micro</parameter>&#160;:</term>
<listitem><simpara> the micro version number
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
