/usr/share/gtk-doc/html/thunarx/thunarx-Variables-and-functions-to-check-the-library-version.html is in thunar-data 1.6.3-1ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Version information</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Thunar Extensions Reference Manual">
<link rel="up" href="thunarx-fundamentals.html" title="Part III. Fundamentals">
<link rel="prev" href="thunarx-fundamentals.html" title="Part III. Fundamentals">
<link rel="next" href="thunarx-abstraction-layer.html" title="Part IV. Abstraction Layer">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="thunarx-fundamentals.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="thunarx-fundamentals.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Thunar Extensions Reference Manual</th>
<td><a accesskey="n" href="thunarx-abstraction-layer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#thunarx-Variables-and-functions-to-check-the-library-version.synopsis" class="shortcut">Top</a>
|
<a href="#thunarx-Variables-and-functions-to-check-the-library-version.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="thunarx-Variables-and-functions-to-check-the-library-version"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="thunarx-Variables-and-functions-to-check-the-library-version.top_of_page"></a>Version information</span></h2>
<p>Version information — Variables and functions to check the library version</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="thunarx-Variables-and-functions-to-check-the-library-version.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="thunarx-Variables-and-functions-to-check-the-library-version.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <thunarx/thunarx.h>
extern const guint <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#thunarx-major-version" title="thunarx_major_version">thunarx_major_version</a>;
extern const guint <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#thunarx-minor-version" title="thunarx_minor_version">thunarx_minor_version</a>;
extern const guint <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#thunarx-micro-version" title="thunarx_micro_version">thunarx_micro_version</a>;
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#thunarx-check-version" title="thunarx_check_version ()">thunarx_check_version</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_major</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_minor</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_micro</code></em>);
#define <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-MAJOR-VERSION:CAPS" title="THUNARX_MAJOR_VERSION">THUNARX_MAJOR_VERSION</a>
#define <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-MINOR-VERSION:CAPS" title="THUNARX_MINOR_VERSION">THUNARX_MINOR_VERSION</a>
#define <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-MICRO-VERSION:CAPS" title="THUNARX_MICRO_VERSION">THUNARX_MICRO_VERSION</a>
#define <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-CHECK-VERSION:CAPS" title="THUNARX_CHECK_VERSION()">THUNARX_CHECK_VERSION</a> (major,
minor,
micro)
</pre>
</div>
<div class="refsect1">
<a name="thunarx-Variables-and-functions-to-check-the-library-version.description"></a><h2>Description</h2>
<p>
The Thunar Extension library provides version information,
which should be used by extensions.
</p>
</div>
<div class="refsect1">
<a name="thunarx-Variables-and-functions-to-check-the-library-version.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="thunarx-major-version"></a><h3>thunarx_major_version</h3>
<pre class="programlisting">extern const guint thunarx_major_version;
</pre>
<p>
The major version number of the
<code class="systemitem">thunarx</code> library (e.g. in
version 0.5.1 this is 0).
</p>
<p>
This variable is in the library, so represents the
<code class="systemitem">thunarx</code> library you have
linked against. Contrast with the <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-MAJOR-VERSION:CAPS" title="THUNARX_MAJOR_VERSION"><span class="type">THUNARX_MAJOR_VERSION</span></a> macro, which
represents the major version of the
<code class="systemitem">thunarx</code> headers you have
included.
</p>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-minor-version"></a><h3>thunarx_minor_version</h3>
<pre class="programlisting">extern const guint thunarx_minor_version;
</pre>
<p>
The minor version number of the
<code class="systemitem">thunarx</code> library (e.g. in
version 0.5.1 this is 5).
</p>
<p>
This variable is in the library, so represents the
<code class="systemitem">thunarx</code> library you have
linked against. Contrast with the <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-MINOR-VERSION:CAPS" title="THUNARX_MINOR_VERSION"><span class="type">THUNARX_MINOR_VERSION</span></a> macro, which
represents the minor version of the
<code class="systemitem">thunarx</code> headers you have
included.
</p>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-micro-version"></a><h3>thunarx_micro_version</h3>
<pre class="programlisting">extern const guint thunarx_micro_version;
</pre>
<p>
The micro version number of the
<code class="systemitem">thunarx</code> library (e.g. in
version 0.5.1 this is 1).
</p>
<p>
This variable is in the library, so represents the
<code class="systemitem">thunarx</code> library you have
linked against. Contrast with the <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-MICRO-VERSION:CAPS" title="THUNARX_MICRO_VERSION"><span class="type">THUNARX_MICRO_VERSION</span></a> macro, which
represents the micro version of the
<code class="systemitem">thunarx</code> headers you have
included.
</p>
</div>
<hr>
<div class="refsect2">
<a name="thunarx-check-version"></a><h3>thunarx_check_version ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * thunarx_check_version (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_major</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_minor</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> required_micro</code></em>);</pre>
<p>
Checks that the <code class="systemitem">thunarx</code> library
in use is compatible with the given version. Generally you would pass in
the constants <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-MAJOR-VERSION:CAPS" title="THUNARX_MAJOR_VERSION"><span class="type">THUNARX_MAJOR_VERSION</span></a>, <a class="link" href="thunarx-Variables-and-functions-to-check-the-library-version.html#THUNARX-MINOR-VERSION:CAPS" title="THUNARX_MINOR_VERSION"><span class="type">THUNARX_MINOR_VERSION</span></a> and
<span class="type">THUNARX_VERSION_MICRO</span> as the three arguments to this function; that produces
a check that the library in use is compatible with the version of
<code class="systemitem">thunarx</code> the extension was
compiled against.
</p>
<p>
This function should be called by extensions in the
<code class="function">thunar_extension_initialize()</code> method to verify that the <code class="systemitem">thunarx</code> library used by file manager is
compatible with the version the extension was compiled with.
</p>
<p>
</p>
<div class="example">
<a name="idp34443856"></a><p class="title"><b>Example 3. Checking the runtime version of the Thunar Extension library</b></p>
<div class="example-contents"><pre class="programlisting">
const gchar *mismatch;
mismatch = thunarx_check_version (THUNARX_VERSION_MAJOR,
THUNARX_VERSION_MINOR,
THUNARX_VERSION_MICRO);
if (G_UNLIKELY (mismatch != NULL))
g_error ("Version mismatch: %s", mismatch);
</pre></div>
</div>
<p><br class="example-break">
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>required_major</code></em> :</span></p></td>
<td>the required major version.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>required_minor</code></em> :</span></p></td>
<td>the required minor version.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>required_micro</code></em> :</span></p></td>
<td>the required micro version.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the library is compatible with the given version,
or a string describing the version mismatch. The returned
string is owned by the library and must not be freed or
modified by the caller.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-MAJOR-VERSION:CAPS"></a><h3>THUNARX_MAJOR_VERSION</h3>
<pre class="programlisting">#define THUNARX_MAJOR_VERSION 1
</pre>
<p>
The major version number of the <code class="systemitem">thunarx</code> library.
Like thunarx_major_version, but from the headers used at application compile time, rather
than from the library linked against at application run time.
</p>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-MINOR-VERSION:CAPS"></a><h3>THUNARX_MINOR_VERSION</h3>
<pre class="programlisting">#define THUNARX_MINOR_VERSION 6
</pre>
<p>
The minor version number of the <code class="systemitem">thunarx</code> library.
Like thunarx_minor_version, but from the headers used at application compile time, rather
than from the library linked against at application run time.
</p>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-MICRO-VERSION:CAPS"></a><h3>THUNARX_MICRO_VERSION</h3>
<pre class="programlisting">#define THUNARX_MICRO_VERSION 3
</pre>
<p>
The micro version number of the <code class="systemitem">thunarx</code> library.
Like thunarx_micro_version, but from the headers used at application compile time, rather
than from the library linked against at application run time.
</p>
</div>
<hr>
<div class="refsect2">
<a name="THUNARX-CHECK-VERSION:CAPS"></a><h3>THUNARX_CHECK_VERSION()</h3>
<pre class="programlisting">#define THUNARX_CHECK_VERSION(major,minor,micro)</pre>
<p>
Checks the version of the <code class="systemitem">thunarx</code> library. Returns
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the version of the <code class="systemitem">thunarx</code> header files is
the same as or newer than the passed-in version.
</p>
<div class="example">
<a name="idp34471744"></a><p class="title"><b>Example 4. Checking the version of the Thunar Extension library</b></p>
<div class="example-contents"><pre class="programlisting">
if (!THUNARX_CHECK_VERSION (0, 1, 0))
g_error ("Thunarx version 0.1.0 or above is required");</pre></div>
</div>
<br class="example-break"><div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
<td>the major version number.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>the minor version number</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>the micro version number.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|