4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>Version Information</title>
5
<title>GNOME Online Accounts Reference Manual: Version Information</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GNOME Online Accounts Reference Manual">
8
8
<link rel="up" href="ref-library.html" title="Part III. Client Library API Reference">
9
9
<link rel="prev" href="goa-GoaError.html" title="GoaError">
10
10
<link rel="next" href="ref-library-generated.html" title="Generated Code">
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17
<td><a accesskey="p" href="goa-GoaError.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ref-library.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GNOME Online Accounts Reference Manual</th>
21
<td><a accesskey="n" href="ref-library-generated.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#goa-Version-Information.synopsis" class="shortcut">Top</a>
26
<a href="#goa-Version-Information.description" class="shortcut">Description</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#goa-Version-Information.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#goa-Version-Information.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
21
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22
<td><a accesskey="u" href="ref-library.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23
<td><a accesskey="p" href="goa-GoaError.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24
<td><a accesskey="n" href="ref-library-generated.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
29
26
<div class="refentry">
30
27
<a name="goa-Version-Information"></a><div class="titlepage"></div>
31
28
<div class="refnamediv"><table width="100%"><tr>
33
30
<h2><span class="refentrytitle"><a name="goa-Version-Information.top_of_page"></a>Version Information</span></h2>
34
31
<p>Version Information — variables and functions to check the GOA version</p>
36
<td valign="top" align="right"></td>
33
<td class="gallery_image" valign="top" align="right"></td>
37
34
</tr></table></div>
38
<div class="refsynopsisdiv">
39
<a name="goa-Version-Information.synopsis"></a><h2>Synopsis</h2>
40
<pre class="synopsis">extern const guint <a class="link" href="goa-Version-Information.html#goa-major-version" title="goa_major_version">goa_major_version</a>;
41
extern const guint <a class="link" href="goa-Version-Information.html#goa-minor-version" title="goa_minor_version">goa_minor_version</a>;
42
extern const guint <a class="link" href="goa-Version-Information.html#goa-micro-version" title="goa_micro_version">goa_micro_version</a>;
43
const <span class="returnvalue">gchar</span> * <a class="link" href="goa-Version-Information.html#goa-check-version" title="goa_check_version ()">goa_check_version</a> (<em class="parameter"><code><span class="type">guint</span> required_major</code></em>,
44
<em class="parameter"><code><span class="type">guint</span> required_minor</code></em>,
45
<em class="parameter"><code><span class="type">guint</span> required_micro</code></em>);
47
#define <a class="link" href="goa-Version-Information.html#GOA-MAJOR-VERSION:CAPS" title="GOA_MAJOR_VERSION">GOA_MAJOR_VERSION</a>
48
#define <a class="link" href="goa-Version-Information.html#GOA-MINOR-VERSION:CAPS" title="GOA_MINOR_VERSION">GOA_MINOR_VERSION</a>
49
#define <a class="link" href="goa-Version-Information.html#GOA-MICRO-VERSION:CAPS" title="GOA_MICRO_VERSION">GOA_MICRO_VERSION</a>
50
#define <a class="link" href="goa-Version-Information.html#GOA-CHECK-VERSION:CAPS" title="GOA_CHECK_VERSION()">GOA_CHECK_VERSION</a> (major,
35
<div class="refsect1">
36
<a name="goa-Version-Information.functions"></a><h2>Functions</h2>
37
<div class="informaltable"><table width="100%" border="0">
39
<col width="150px" class="functions_return">
40
<col class="functions_name">
44
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
46
<td class="function_name">
47
<a class="link" href="goa-Version-Information.html#goa-check-version" title="goa_check_version ()">goa_check_version</a> <span class="c_punctuation">()</span>
51
<td class="define_keyword">#define</td>
52
<td class="function_name">
53
<a class="link" href="goa-Version-Information.html#GOA-CHECK-VERSION:CAPS" title="GOA_CHECK_VERSION()">GOA_CHECK_VERSION</a><span class="c_punctuation">()</span>
59
<div class="refsect1">
60
<a name="goa-Version-Information.other"></a><h2>Types and Values</h2>
61
<div class="informaltable"><table width="100%" border="0">
63
<col width="150px" class="name">
64
<col class="description">
68
<td class="variable_type">extern const guint </td>
69
<td class="function_name"><a class="link" href="goa-Version-Information.html#goa-major-version" title="goa_major_version">goa_major_version</a></td>
72
<td class="variable_type">extern const guint </td>
73
<td class="function_name"><a class="link" href="goa-Version-Information.html#goa-minor-version" title="goa_minor_version">goa_minor_version</a></td>
76
<td class="variable_type">extern const guint </td>
77
<td class="function_name"><a class="link" href="goa-Version-Information.html#goa-micro-version" title="goa_micro_version">goa_micro_version</a></td>
80
<td class="define_keyword">#define</td>
81
<td class="function_name"><a class="link" href="goa-Version-Information.html#GOA-MAJOR-VERSION:CAPS" title="GOA_MAJOR_VERSION">GOA_MAJOR_VERSION</a></td>
84
<td class="define_keyword">#define</td>
85
<td class="function_name"><a class="link" href="goa-Version-Information.html#GOA-MINOR-VERSION:CAPS" title="GOA_MINOR_VERSION">GOA_MINOR_VERSION</a></td>
88
<td class="define_keyword">#define</td>
89
<td class="function_name"><a class="link" href="goa-Version-Information.html#GOA-MICRO-VERSION:CAPS" title="GOA_MICRO_VERSION">GOA_MICRO_VERSION</a></td>
94
<div class="refsect1">
95
<a name="goa-Version-Information.object-hierarchy"></a><h2>Object Hierarchy</h2>
55
99
<div class="refsect1">
56
100
<a name="goa-Version-Information.description"></a><h2>Description</h2>
58
GOA provides version information, primarily useful in configure
101
<p>GOA provides version information, primarily useful in configure
59
102
checks for builds that have a configure script. Applications will
60
not typically use the features described here.
103
not typically use the features described here.</p>
63
105
<div class="refsect1">
64
<a name="goa-Version-Information.details"></a><h2>Details</h2>
65
<div class="refsect2">
66
<a name="goa-major-version"></a><h3>goa_major_version</h3>
67
<pre class="programlisting">extern const guint goa_major_version;
73
<div class="refsect2">
74
<a name="goa-minor-version"></a><h3>goa_minor_version</h3>
75
<pre class="programlisting">extern const guint goa_minor_version;
81
<div class="refsect2">
82
<a name="goa-micro-version"></a><h3>goa_micro_version</h3>
83
<pre class="programlisting">extern const guint goa_micro_version;
89
<div class="refsect2">
90
<a name="goa-check-version"></a><h3>goa_check_version ()</h3>
91
<pre class="programlisting">const <span class="returnvalue">gchar</span> * goa_check_version (<em class="parameter"><code><span class="type">guint</span> required_major</code></em>,
92
<em class="parameter"><code><span class="type">guint</span> required_minor</code></em>,
93
<em class="parameter"><code><span class="type">guint</span> required_micro</code></em>);</pre>
95
Checks that the GOA library in use is compatible with the
106
<a name="goa-Version-Information.functions_details"></a><h2>Functions</h2>
107
<div class="refsect2">
108
<a name="goa-check-version"></a><h3>goa_check_version ()</h3>
109
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
110
goa_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>,
111
<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>,
112
<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>
113
<p>Checks that the GOA library in use is compatible with the
96
114
given version. Generally you would pass in the constants
97
115
<a class="link" href="goa-Version-Information.html#GOA-MAJOR-VERSION:CAPS" title="GOA_MAJOR_VERSION"><span class="type">GOA_MAJOR_VERSION</span></a>, <a class="link" href="goa-Version-Information.html#GOA-MINOR-VERSION:CAPS" title="GOA_MINOR_VERSION"><span class="type">GOA_MINOR_VERSION</span></a>, <a class="link" href="goa-Version-Information.html#GOA-MICRO-VERSION:CAPS" title="GOA_MICRO_VERSION"><span class="type">GOA_MICRO_VERSION</span></a>
98
116
as the three arguments to this function; that produces
99
117
a check that the library in use is compatible with
100
118
the version of GOA the application or module was compiled
104
Compatibility is defined by two things: first the version
120
<p>Compatibility is defined by two things: first the version
105
121
of the running library is newer than the version
106
<em class="parameter"><code>required_major</code></em>.<em class="parameter"><code>required_minor</code></em>.<em class="parameter"><code>required_micro</code></em>. Second
122
<em class="parameter"><code>required_major</code></em>
123
.<em class="parameter"><code>required_minor</code></em>
124
.<em class="parameter"><code>required_micro</code></em>
107
126
the running library must be binary compatible with the
108
version <em class="parameter"><code>required_major</code></em>.<em class="parameter"><code>required_minor</code></em>.<em class="parameter"><code>required_micro</code></em>
109
(same major and minor version).
111
<div class="variablelist"><table border="0" class="variablelist">
127
version <em class="parameter"><code>required_major</code></em>
128
.<em class="parameter"><code>required_minor</code></em>
129
.<em class="parameter"><code>required_micro</code></em>
131
(same major and minor version).</p>
132
<div class="refsect3">
133
<a name="id-1.4.4.7.2.6"></a><h4>Parameters</h4>
134
<div class="informaltable"><table width="100%" border="0">
113
<col align="left" valign="top">
136
<col width="150px" class="parameters_name">
137
<col class="parameters_description">
138
<col width="200px" class="parameters_annotations">
118
<td><p><span class="term"><em class="parameter"><code>required_major</code></em> :</span></p></td>
119
<td>the required major version.</td>
122
<td><p><span class="term"><em class="parameter"><code>required_minor</code></em> :</span></p></td>
123
<td>the required minor version.</td>
126
<td><p><span class="term"><em class="parameter"><code>required_micro</code></em> :</span></p></td>
127
<td>the required micro version.</td>
130
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
132
<code class="literal">NULL</code> if the GOA library is compatible with the
142
<td class="parameter_name"><p>required_major</p></td>
143
<td class="parameter_description"><p>the required major version.</p></td>
144
<td class="parameter_annotations"> </td>
147
<td class="parameter_name"><p>required_minor</p></td>
148
<td class="parameter_description"><p>the required minor version.</p></td>
149
<td class="parameter_annotations"> </td>
152
<td class="parameter_name"><p>required_micro</p></td>
153
<td class="parameter_description"><p>the required micro version.</p></td>
154
<td class="parameter_annotations"> </td>
159
<div class="refsect3">
160
<a name="id-1.4.4.7.2.7"></a><h4>Returns</h4>
161
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the GOA library is compatible with the
133
162
given version, or a string describing the version mismatch.
134
163
The returned string is owned by GOA and must not be modified
139
<p class="since">Since 3.8</p>
142
<div class="refsect2">
143
<a name="GOA-MAJOR-VERSION:CAPS"></a><h3>GOA_MAJOR_VERSION</h3>
144
<pre class="programlisting">#define GOA_MAJOR_VERSION 3
147
The major version number of the GOA daemon and library.
150
Like <a class="link" href="goa-Version-Information.html#goa-major-version" title="goa_major_version"><span class="type">goa_major_version</span></a>, but from the headers used at
151
application compile time, rather than from the library
152
linked against at application run time.
154
<p class="since">Since 3.8</p>
157
<div class="refsect2">
158
<a name="GOA-MINOR-VERSION:CAPS"></a><h3>GOA_MINOR_VERSION</h3>
159
<pre class="programlisting">#define GOA_MINOR_VERSION 10
162
The minor version number of the GOA daemon and library.
165
Like <a class="link" href="goa-Version-Information.html#goa-minor-version" title="goa_minor_version"><span class="type">goa_minor_version</span></a>, but from the headers used at
166
application compile time, rather than from the library
167
linked against at application run time.
169
<p class="since">Since 3.8</p>
172
<div class="refsect2">
173
<a name="GOA-MICRO-VERSION:CAPS"></a><h3>GOA_MICRO_VERSION</h3>
174
<pre class="programlisting">#define GOA_MICRO_VERSION 3
177
The micro version number of the GOA daemon and library.
180
Like <a class="link" href="goa-Version-Information.html#goa-micro-version" title="goa_micro_version"><span class="type">goa_micro_version</span></a>, but from the headers used at
181
application compile time, rather than from the library
182
linked against at application run time.
184
167
<p class="since">Since 3.8</p>
187
170
<div class="refsect2">
188
171
<a name="GOA-CHECK-VERSION:CAPS"></a><h3>GOA_CHECK_VERSION()</h3>
189
172
<pre class="programlisting">#define GOA_CHECK_VERSION(major,minor,micro)</pre>
191
Checks the version of the GOA library that is being compiled
173
<p>Checks the version of the GOA library that is being compiled
196
175
<div class="example">
197
<a name="id-1.4.4.5.9.5.1"></a><p class="title"><b>Example 1. Checking the version of the GOA library</b></p>
176
<a name="id-1.4.4.7.3.5"></a><p class="title"><b>Example 1. Checking the version of the GOA library</b></p>
198
177
<div class="example-contents">
199
178
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
202
181
<td class="listing_lines" align="right"><pre>1
204
183
<td class="listing_code"><pre class="programlisting"><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(!</span><span class="function"><a href="goa-Version-Information.html#GOA-CHECK-VERSION:CAPS">GOA_CHECK_VERSION</a></span><span class="normal"> </span><span class="symbol">(</span><span class="number">3</span><span class="symbol">,</span><span class="normal"> </span><span class="number">8</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">))</span>
205
<span class="normal"> </span><span class="function">g_error</span><span class="normal"> </span><span class="symbol">(</span><span class="string">"GOA version 3.8.0 or above is needed"</span><span class="symbol">);</span></pre></td>
184
<span class="normal"> </span><span class="function"><a href="http://library.gnome.org/devel/glib/unstable/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"GOA version 3.8.0 or above is needed"</span><span class="symbol">);</span></pre></td>
212
<p><br class="example-break">
215
See <a class="link" href="goa-Version-Information.html#goa-check-version" title="goa_check_version ()"><code class="function">goa_check_version()</code></a> for a runtime check.
217
<div class="variablelist"><table border="0" class="variablelist">
191
<br class="example-break"><p>See <a class="link" href="goa-Version-Information.html#goa-check-version" title="goa_check_version ()"><code class="function">goa_check_version()</code></a> for a runtime check.</p>
192
<div class="refsect3">
193
<a name="id-1.4.4.7.3.7"></a><h4>Parameters</h4>
194
<div class="informaltable"><table width="100%" border="0">
219
<col align="left" valign="top">
196
<col width="150px" class="parameters_name">
197
<col class="parameters_description">
198
<col width="200px" class="parameters_annotations">
224
<td><p><span class="term"><em class="parameter"><code>major</code></em> :</span></p></td>
225
<td>the major version to check for</td>
228
<td><p><span class="term"><em class="parameter"><code>minor</code></em> :</span></p></td>
229
<td>the minor version to check for</td>
232
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
233
<td>the micro version to check for</td>
236
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
238
<code class="literal">TRUE</code> if the version of the GOA header files
239
is the same as or newer than the passed-in version.</td>
202
<td class="parameter_name"><p>major</p></td>
203
<td class="parameter_description"><p>the major version to check for</p></td>
204
<td class="parameter_annotations"> </td>
207
<td class="parameter_name"><p>minor</p></td>
208
<td class="parameter_description"><p>the minor version to check for</p></td>
209
<td class="parameter_annotations"> </td>
212
<td class="parameter_name"><p>micro</p></td>
213
<td class="parameter_description"><p>the micro version to check for</p></td>
214
<td class="parameter_annotations"> </td>
219
<div class="refsect3">
220
<a name="id-1.4.4.7.3.8"></a><h4>Returns</h4>
221
<p> <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 GOA header files
222
is the same as or newer than the passed-in version.</p>
225
<p class="since">Since 3.8</p>
228
<div class="refsect1">
229
<a name="goa-Version-Information.other_details"></a><h2>Types and Values</h2>
230
<div class="refsect2">
231
<a name="goa-major-version"></a><h3>goa_major_version</h3>
232
<pre class="programlisting">extern const guint goa_major_version;
238
<div class="refsect2">
239
<a name="goa-minor-version"></a><h3>goa_minor_version</h3>
240
<pre class="programlisting">extern const guint goa_minor_version;
246
<div class="refsect2">
247
<a name="goa-micro-version"></a><h3>goa_micro_version</h3>
248
<pre class="programlisting">extern const guint goa_micro_version;
254
<div class="refsect2">
255
<a name="GOA-MAJOR-VERSION:CAPS"></a><h3>GOA_MAJOR_VERSION</h3>
256
<pre class="programlisting">#define GOA_MAJOR_VERSION 3
258
<p>The major version number of the GOA daemon and library.</p>
259
<p>Like <a class="link" href="goa-Version-Information.html#goa-major-version" title="goa_major_version"><span class="type">goa_major_version</span></a>, but from the headers used at
260
application compile time, rather than from the library
261
linked against at application run time.</p>
262
<p class="since">Since 3.8</p>
265
<div class="refsect2">
266
<a name="GOA-MINOR-VERSION:CAPS"></a><h3>GOA_MINOR_VERSION</h3>
267
<pre class="programlisting">#define GOA_MINOR_VERSION 12
269
<p>The minor version number of the GOA daemon and library.</p>
270
<p>Like <a class="link" href="goa-Version-Information.html#goa-minor-version" title="goa_minor_version"><span class="type">goa_minor_version</span></a>, but from the headers used at
271
application compile time, rather than from the library
272
linked against at application run time.</p>
273
<p class="since">Since 3.8</p>
276
<div class="refsect2">
277
<a name="GOA-MICRO-VERSION:CAPS"></a><h3>GOA_MICRO_VERSION</h3>
278
<pre class="programlisting">#define GOA_MICRO_VERSION 2
280
<p>The micro version number of the GOA daemon and library.</p>
281
<p>Like <a class="link" href="goa-Version-Information.html#goa-micro-version" title="goa_micro_version"><span class="type">goa_micro_version</span></a>, but from the headers used at
282
application compile time, rather than from the library
283
linked against at application run time.</p>
243
284
<p class="since">Since 3.8</p>
247
288
<div class="footer">
249
Generated by GTK-Doc V1.19</div>
290
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'