/usr/share/gtk-doc/html/libgwyddion/libgwyddion-gwyversion.html is in libgwyddion20-doc 2.34-3ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Library Reference Manual: gwyversion</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="prev" href="libgwyddion-gwyutils.html" title="gwyutils">
<link rel="next" href="GwyEnum.html" title="GwyEnum">
<meta name="generator" content="GTK-Doc V1.19 (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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#libgwyddion-gwyversion.description" class="shortcut">Description</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="libgwyddion-gwyutils.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyEnum.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyddion-gwyversion"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyddion-gwyversion.top_of_page"></a>gwyversion</span></h2>
<p>gwyversion — Version information</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyddion-gwyversion.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwyddion/gwyddion.h>
#define <a class="link" href="libgwyddion-gwyversion.html#GWY-VERSION-MAJOR:CAPS" title="GWY_VERSION_MAJOR">GWY_VERSION_MAJOR</a>
#define <a class="link" href="libgwyddion-gwyversion.html#GWY-VERSION-MINOR:CAPS" title="GWY_VERSION_MINOR">GWY_VERSION_MINOR</a>
#define <a class="link" href="libgwyddion-gwyversion.html#GWY-VERSION-STRING:CAPS" title="GWY_VERSION_STRING">GWY_VERSION_STRING</a>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgwyddion-gwyversion.html#gwy-version-major" title="gwy_version_major ()">gwy_version_major</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> <a class="link" href="libgwyddion-gwyversion.html#gwy-version-minor" title="gwy_version_minor ()">gwy_version_minor</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgwyddion-gwyversion.html#gwy-version-string" title="gwy_version_string ()">gwy_version_string</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyddion-gwyversion.description"></a><h2>Description</h2>
<p>
Macros like <a class="link" href="libgwyddion-gwyversion.html#GWY-VERSION-MAJOR:CAPS" title="GWY_VERSION_MAJOR"><code class="literal">GWY_VERSION_MAJOR</code></a> can be used for compile-time version checks,
that is they tell what version a module or app is being compiled or was
compiled with.
</p>
<p>
On the other hand functions like <a class="link" href="libgwyddion-gwyversion.html#gwy-version-major" title="gwy_version_major ()"><code class="function">gwy_version_major()</code></a> can be used to run-time
version checks and they tell what version a module or app was linked or
is running with.
</p>
</div>
<div class="refsect1">
<a name="libgwyddion-gwyversion.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GWY-VERSION-MAJOR:CAPS"></a><h3>GWY_VERSION_MAJOR</h3>
<pre class="programlisting">#define GWY_VERSION_MAJOR 2
</pre>
<p>
Expands to the major version of Gwyddion as a number.
</p>
<p>
If the version is 1.99.7.20060604, this macro is defined as 1.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GWY-VERSION-MINOR:CAPS"></a><h3>GWY_VERSION_MINOR</h3>
<pre class="programlisting">#define GWY_VERSION_MINOR 34
</pre>
<p>
Expands to the minor version of Gwyddion as a number.
</p>
<p>
If the version is 1.99.7.20060604, this macro is defined as 99.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GWY-VERSION-STRING:CAPS"></a><h3>GWY_VERSION_STRING</h3>
<pre class="programlisting">#define GWY_VERSION_STRING "2.34"
</pre>
<p>
Expands to the full Gwyddion version as a string.
</p>
<p>
If the version is 1.99.7.20060604, this macro is defined as
<code class="literal">"1.99.7.20060604"</code>.
</p>
<p>
See <a class="link" href="libgwyddion-gwyversion.html#gwy-version-string" title="gwy_version_string ()"><code class="function">gwy_version_string()</code></a> for caveats.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-version-major"></a><h3>gwy_version_major ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gwy_version_major (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the major version of Gwyddion.
</p>
<p>
If the version is 1.99.7.20060604, this function returns 1.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The major version.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-version-minor"></a><h3>gwy_version_minor ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a> gwy_version_minor (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the minor version of Gwyddion.
</p>
<p>
If the version is 1.99.7.20060604, this function returns 99.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The minor version.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-version-string"></a><h3>gwy_version_string ()</h3>
<pre class="programlisting">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_version_string (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Gets the full Gwyddion version as a string.
</p>
<p>
If the version is 1.99.7.20060604, this function returns
<code class="literal">"1.99.7.20060604"</code>.
</p>
<p>
This is the only method to get finer version information than major.minor.
However, only development versions use finer versioning than major.minor
therefore a module or app requiring such information is probably broken
anyway. A meaningful use is to advertise the version of Gwyddion your app
runs with.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The full version as a constant string.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|