/usr/share/gtk-doc/html/ctpl/ctpl-Version-information.html is in libctpl-doc 0.3.3.dfsg-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 | <!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.75.2">
<link rel="home" href="index.html" title="CTPL Reference Manual">
<link rel="up" href="ch02.html" title="API reference">
<link rel="prev" href="ch02.html" title="API reference">
<link rel="next" href="ctpl-CtplValue.html" title="CtplValue">
<meta name="generator" content="GTK-Doc V1.17 (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="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">CTPL Reference Manual</th>
<td><a accesskey="n" href="ctpl-CtplValue.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ctpl-Version-information.synopsis" class="shortcut">Top</a>
|
<a href="#ctpl-Version-information.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="ctpl-Version-information"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ctpl-Version-information.top_of_page"></a>Version information</span></h2>
<p>Version information — Variables and functions to check the CTPL version</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ctpl-Version-information.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <ctpl/ctpl.h>
#define <a class="link" href="ctpl-Version-information.html#CTPL-MAJOR-VERSION:CAPS" title="CTPL_MAJOR_VERSION">CTPL_MAJOR_VERSION</a>
#define <a class="link" href="ctpl-Version-information.html#CTPL-MINOR-VERSION:CAPS" title="CTPL_MINOR_VERSION">CTPL_MINOR_VERSION</a>
#define <a class="link" href="ctpl-Version-information.html#CTPL-MICRO-VERSION:CAPS" title="CTPL_MICRO_VERSION">CTPL_MICRO_VERSION</a>
#define <a class="link" href="ctpl-Version-information.html#CTPL-CHECK-VERSION:CAPS" title="CTPL_CHECK_VERSION()">CTPL_CHECK_VERSION</a> (major,
minor,
micro)
extern const guint <a class="link" href="ctpl-Version-information.html#ctpl-major-version" title="ctpl_major_version">ctpl_major_version</a>;
extern const guint <a class="link" href="ctpl-Version-information.html#ctpl-minor-version" title="ctpl_minor_version">ctpl_minor_version</a>;
extern const guint <a class="link" href="ctpl-Version-information.html#ctpl-micro-version" title="ctpl_micro_version">ctpl_micro_version</a>;
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="ctpl-Version-information.html#ctpl-check-version" title="ctpl_check_version ()">ctpl_check_version</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> major</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> minor</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> micro</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ctpl-Version-information.description"></a><h2>Description</h2>
<p>
Provides CTPL version checks.
</p>
</div>
<div class="refsect1">
<a name="ctpl-Version-information.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CTPL-MAJOR-VERSION:CAPS"></a><h3>CTPL_MAJOR_VERSION</h3>
<pre class="programlisting">#define CTPL_MAJOR_VERSION 0
</pre>
<p>
Major version of the CTPL library the application is compiled against.
</p>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="CTPL-MINOR-VERSION:CAPS"></a><h3>CTPL_MINOR_VERSION</h3>
<pre class="programlisting">#define CTPL_MINOR_VERSION 3
</pre>
<p>
Minor version of the CTPL library the application is compiled against.
</p>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="CTPL-MICRO-VERSION:CAPS"></a><h3>CTPL_MICRO_VERSION</h3>
<pre class="programlisting">#define CTPL_MICRO_VERSION 3
</pre>
<p>
Micro version of the CTPL library the application is compiled against.
</p>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="CTPL-CHECK-VERSION:CAPS"></a><h3>CTPL_CHECK_VERSION()</h3>
<pre class="programlisting">#define CTPL_CHECK_VERSION(major, minor, micro)</pre>
<p>
Checks whether the CTPL version is equal or newer than the passed-in version.
</p>
<p>
This provides a compile-time check that can be used in preprocessor checks.
If you want a run-time check, use <a class="link" href="ctpl-Version-information.html#ctpl-check-version" title="ctpl_check_version ()"><code class="function">ctpl_check_version()</code></a>.
</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>CTPL major version required</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>CTPL minor version required</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>CTPL micro version required</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the version is compatible, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-major-version"></a><h3>ctpl_major_version</h3>
<pre class="programlisting">extern const guint ctpl_major_version;
</pre>
<p>
Major version of the CTPL library the application is running with.
</p>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-minor-version"></a><h3>ctpl_minor_version</h3>
<pre class="programlisting">extern const guint ctpl_minor_version;
</pre>
<p>
Minor version of the CTPL library the application is running with.
</p>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-micro-version"></a><h3>ctpl_micro_version</h3>
<pre class="programlisting">extern const guint ctpl_micro_version;
</pre>
<p>
Micro version of the CTPL library the application is running with.
</p>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-check-version"></a><h3>ctpl_check_version ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> ctpl_check_version (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> major</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> minor</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> micro</code></em>);</pre>
<p>
Checks whether the CTPL library in use is presumably compatible with the
given version. You would generally pass in the constants
<a class="link" href="ctpl-Version-information.html#CTPL-MAJOR-VERSION:CAPS" title="CTPL_MAJOR_VERSION"><span class="type">CTPL_MAJOR_VERSION</span></a>, <a class="link" href="ctpl-Version-information.html#CTPL-MINOR-VERSION:CAPS" title="CTPL_MINOR_VERSION"><span class="type">CTPL_MINOR_VERSION</span></a>, <a class="link" href="ctpl-Version-information.html#CTPL-MICRO-VERSION:CAPS" title="CTPL_MICRO_VERSION"><span class="type">CTPL_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 CTPL the application was built against.
</p>
<p>
This function currently simply checks whether the actual CTPL version is
equal or newer than the passed in version.
</p>
<p>
This provides a run-time check, unlike <a class="link" href="ctpl-Version-information.html#CTPL-CHECK-VERSION:CAPS" title="CTPL_CHECK_VERSION()"><code class="literal">CTPL_CHECK_VERSION</code></a> that does a
compile-time check.
</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>CTPL major version required</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
<td>CTPL minor version required</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
<td>CTPL micro version required</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the version is compatible, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|