/usr/share/gtk-doc/html/libxfce4ui/libxfce4ui-libxfce4ui-config.html is in libxfce4ui-1-dev 4.8.1-1.
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 | <!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.76.1">
<link rel="home" href="index.html" title="Libxfce4ui Reference Manual">
<link rel="up" href="libxfce4ui-fundamentals.html" title="Part II. Xfce Fundamentals">
<link rel="prev" href="libxfce4ui-fundamentals.html" title="Part II. Xfce Fundamentals">
<link rel="next" href="libxfce4ui-xfce-spawn.html" title="Xfce Spawn">
<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="libxfce4ui-fundamentals.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libxfce4ui-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">Libxfce4ui Reference Manual</th>
<td><a accesskey="n" href="libxfce4ui-xfce-spawn.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libxfce4ui-libxfce4ui-config.synopsis" class="shortcut">Top</a>
|
<a href="#libxfce4ui-libxfce4ui-config.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libxfce4ui-libxfce4ui-config"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libxfce4ui-libxfce4ui-config.top_of_page"></a>Version Information</span></h2>
<p>Version Information — Variables and functions to check the Libxfce4ui version.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libxfce4ui-libxfce4ui-config.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libxfce4ui/libxfce4ui.h>
const <span class="returnvalue">gchar</span> * <a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-check-version" title="libxfce4ui_check_version ()">libxfce4ui_check_version</a> (<em class="parameter"><code><span class="type">guint</span> required_major</code></em>,
<em class="parameter"><code><span class="type">guint</span> required_minor</code></em>,
<em class="parameter"><code><span class="type">guint</span> required_micro</code></em>);
extern const guint <a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-major-version" title="libxfce4ui_major_version">libxfce4ui_major_version</a>;
extern const guint <a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-minor-version" title="libxfce4ui_minor_version">libxfce4ui_minor_version</a>;
extern const guint <a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-micro-version" title="libxfce4ui_micro_version">libxfce4ui_micro_version</a>;
#define <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MAJOR-VERSION:CAPS" title="LIBXFCE4UI_MAJOR_VERSION">LIBXFCE4UI_MAJOR_VERSION</a>
#define <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MINOR-VERSION:CAPS" title="LIBXFCE4UI_MINOR_VERSION">LIBXFCE4UI_MINOR_VERSION</a>
#define <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MICRO-VERSION:CAPS" title="LIBXFCE4UI_MICRO_VERSION">LIBXFCE4UI_MICRO_VERSION</a>
#define <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-CHECK-VERSION:CAPS" title="LIBXFCE4UI_CHECK_VERSION()">LIBXFCE4UI_CHECK_VERSION</a> (major,
minor,
micro)
</pre>
</div>
<div class="refsect1">
<a name="libxfce4ui-libxfce4ui-config.description"></a><h2>Description</h2>
<p>
Libxfce4ui provides version information, primarily useful in configure
checks for builds that have a configure script. Applications will not
typically use the features described here.
</p>
</div>
<div class="refsect1">
<a name="libxfce4ui-libxfce4ui-config.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="libxfce4ui-check-version"></a><h3>libxfce4ui_check_version ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * libxfce4ui_check_version (<em class="parameter"><code><span class="type">guint</span> required_major</code></em>,
<em class="parameter"><code><span class="type">guint</span> required_minor</code></em>,
<em class="parameter"><code><span class="type">guint</span> required_micro</code></em>);</pre>
<p>
Checks that the <code class="systemitem">libxfce4ui</code> library
in use is compatible with the given version. Generally you would pass in
the constants <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MAJOR-VERSION:CAPS" title="LIBXFCE4UI_MAJOR_VERSION"><span class="type">LIBXFCE4UI_MAJOR_VERSION</span></a>, <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MINOR-VERSION:CAPS" title="LIBXFCE4UI_MINOR_VERSION"><span class="type">LIBXFCE4UI_MINOR_VERSION</span></a> and
<a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MICRO-VERSION:CAPS" title="LIBXFCE4UI_MICRO_VERSION"><span class="type">LIBXFCE4UI_MICRO_VERSION</span></a> 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">libxfce4ui</code> the extension was
compiled against.
</p>
<p>
</p>
<div class="example">
<a name="id593024"></a><p class="title"><b>Example 1. Checking the runtime version of the Libxfce4ui library</b></p>
<div class="example-contents"><pre class="programlisting">
const gchar *mismatch;
mismatch = libxfce4ui_check_version (LIBXFCE4UI_MAJOR_VERSION,
LIBXFCE4UI_MINOR_VERSION,
LIBXFCE4UI_MICRO_VERSION);
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">
<col align="left" valign="top">
<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>
<code class="literal">NULL</code> 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="libxfce4ui-major-version"></a><h3>libxfce4ui_major_version</h3>
<pre class="programlisting">extern const guint libxfce4ui_major_version;
</pre>
<p>
The major version number of the Libxfce4ui library (e.g. in version
1.2.3 this is 1).
</p>
<p>
This variable is in the library, so represents the Libxfce4ui library
you have linked against. Contrast with the <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MAJOR-VERSION:CAPS" title="LIBXFCE4UI_MAJOR_VERSION"><span class="type">LIBXFCE4UI_MAJOR_VERSION</span></a>
macro, which represents the major version of the Libxfce4ui headers
you have included.
</p>
</div>
<hr>
<div class="refsect2">
<a name="libxfce4ui-minor-version"></a><h3>libxfce4ui_minor_version</h3>
<pre class="programlisting">extern const guint libxfce4ui_minor_version;
</pre>
<p>
The minor version number of the Libxfce4ui library (e.g. in version
1.2.3 this is 2).
</p>
<p>
This variable is in the library, so represents the Libxfce4ui library
you have linked against. Contrast with the <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MINOR-VERSION:CAPS" title="LIBXFCE4UI_MINOR_VERSION"><span class="type">LIBXFCE4UI_MINOR_VERSION</span></a>
macro, which represents the minor version of the Libxfce4ui headers
you have included.
</p>
</div>
<hr>
<div class="refsect2">
<a name="libxfce4ui-micro-version"></a><h3>libxfce4ui_micro_version</h3>
<pre class="programlisting">extern const guint libxfce4ui_micro_version;
</pre>
<p>
The micro version number of the Libxfce4ui library (e.g. in version
1.2.3 this is 3).
</p>
<p>
This variable is in the library, so represents the Libxfce4ui library
you have linked against. Contrast with the <a class="link" href="libxfce4ui-libxfce4ui-config.html#LIBXFCE4UI-MICRO-VERSION:CAPS" title="LIBXFCE4UI_MICRO_VERSION"><span class="type">LIBXFCE4UI_MICRO_VERSION</span></a>
macro, which represents the micro version of the Libxfce4ui headers
you have included.
</p>
</div>
<hr>
<div class="refsect2">
<a name="LIBXFCE4UI-MAJOR-VERSION:CAPS"></a><h3>LIBXFCE4UI_MAJOR_VERSION</h3>
<pre class="programlisting">#define LIBXFCE4UI_MAJOR_VERSION (4)
</pre>
<p>
Like <a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-major-version" title="libxfce4ui_major_version"><span class="type">libxfce4ui_major_version</span></a>, 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="LIBXFCE4UI-MINOR-VERSION:CAPS"></a><h3>LIBXFCE4UI_MINOR_VERSION</h3>
<pre class="programlisting">#define LIBXFCE4UI_MINOR_VERSION (8)
</pre>
<p>
Like <a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-minor-version" title="libxfce4ui_minor_version"><span class="type">libxfce4ui_minor_version</span></a>, 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="LIBXFCE4UI-MICRO-VERSION:CAPS"></a><h3>LIBXFCE4UI_MICRO_VERSION</h3>
<pre class="programlisting">#define LIBXFCE4UI_MICRO_VERSION (1)
</pre>
<p>
Like <a class="link" href="libxfce4ui-libxfce4ui-config.html#libxfce4ui-micro-version" title="libxfce4ui_micro_version"><span class="type">libxfce4ui_micro_version</span></a>, 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="LIBXFCE4UI-CHECK-VERSION:CAPS"></a><h3>LIBXFCE4UI_CHECK_VERSION()</h3>
<pre class="programlisting">#define LIBXFCE4UI_CHECK_VERSION(major,minor,micro)</pre>
<p>
Returns <code class="literal">TRUE</code> if the version of the Libxfce4ui header files is the same
as or newer than the passed-in version.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
<td>major version (e.g. 1 for version 1.2.3)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>minor version (e.g. 2 for version 1.2.3)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>micro version (e.g. 3 for version 1.2.3)</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|