~ubuntu-branches/ubuntu/karmic/exo/karmic

« back to all changes in this revision

Viewing changes to docs/reference/html/exo-Version-Information.html

  • Committer: Bazaar Package Importer
  • Author(s): Lionel Le Folgoc
  • Date: 2009-08-21 14:28:56 UTC
  • mfrom: (1.1.22 upstream)
  • Revision ID: james.westby@ubuntu.com-20090821142856-xp7o7hl7x9xa2213
Tags: 0.3.102-1ubuntu1
* Merge from Debian unstable, remaining Ubuntu changes:
  - debian/rules:
    + Removed mangling of helpers.rc
    + Add --enable-gtk-doc switch to configure
  - debian/control:
    + Add build-dep on gtk-doc-tools
    + Update Vcs-* fields
  - debian/patches:
    + 04_update_helpers.patch: patched libexo's firefox helper desktop file
      to use firefox-3.0 icon instead of firefox icon
    + xubuntu-default-mount-options.patch: change default mount options for
      vfat, iso9660, ntfs
    + series: refreshed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>Version Information</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
 
<link rel="start" href="index.html" title="exo Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
7
<link rel="home" href="index.html" title="exo Reference Manual">
8
8
<link rel="up" href="exo-miscelleanous.html" title="Part VI. Miscelleanous">
9
9
<link rel="prev" href="exo-miscelleanous.html" title="Part VI. Miscelleanous">
10
10
<link rel="next" href="exo-Binding-Properties-Functions.html" title="Binding Properties Functions">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="exo-overview.html" title="Part I. Overview">
14
14
<link rel="part" href="exo-toolbars.html" title="Part II. Editable Toolbars">
30
30
<th width="100%" align="center">exo Reference Manual</th>
31
31
<td><a accesskey="n" href="exo-Binding-Properties-Functions.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
32
32
</tr>
33
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#exo-Version-Information.synopsis" class="shortcut">Top</a>
34
 
                   | 
35
 
                  <a href="#exo-Version-Information.description" class="shortcut">Description</a></nobr></td></tr>
 
33
<tr><td colspan="5" class="shortcuts">
 
34
<a href="#exo-Version-Information.synopsis" class="shortcut">Top</a>
 
35
                 | 
 
36
                <a href="#exo-Version-Information.description" class="shortcut">Description</a>
 
37
</td></tr>
36
38
</table>
37
39
<div class="refentry" lang="en">
38
40
<a name="exo-Version-Information"></a><div class="titlepage"></div>
56
58
extern              const guint <a class="link" href="exo-Version-Information.html#exo-major-version" title="exo_major_version">exo_major_version</a>;
57
59
extern              const guint <a class="link" href="exo-Version-Information.html#exo-minor-version" title="exo_minor_version">exo_minor_version</a>;
58
60
extern              const guint <a class="link" href="exo-Version-Information.html#exo-micro-version" title="exo_micro_version">exo_micro_version</a>;
59
 
const <a
60
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
61
 
>gchar</a>*        <a class="link" href="exo-Version-Information.html#exo-check-version" title="exo_check_version ()">exo_check_version</a>                   (<a
62
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
63
 
>guint</a> required_major,
64
 
                                                         <a
65
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
66
 
>guint</a> required_minor,
67
 
                                                         <a
68
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
69
 
>guint</a> required_micro);
 
61
const gchar *       <a class="link" href="exo-Version-Information.html#exo-check-version" title="exo_check_version ()">exo_check_version</a>                   (guint required_major,
 
62
                                                         guint required_minor,
 
63
                                                         guint required_micro);
70
64
 
71
 
#define             <a class="link" href="exo-Version-Information.html#EXO-MAJOR-VERSION:CAPS" title="EXO_MAJOR_VERSION">EXO_MAJOR_VERSION</a>
72
 
#define             <a class="link" href="exo-Version-Information.html#EXO-MINOR-VERSION:CAPS" title="EXO_MINOR_VERSION">EXO_MINOR_VERSION</a>
73
 
#define             <a class="link" href="exo-Version-Information.html#EXO-MICRO-VERSION:CAPS" title="EXO_MICRO_VERSION">EXO_MICRO_VERSION</a>
74
 
#define             <a class="link" href="exo-Version-Information.html#EXO-CHECK-VERSION:CAPS" title="EXO_CHECK_VERSION()">EXO_CHECK_VERSION</a>                   (major,minor,micro)
 
65
#define             <a class="link" href="exo-Version-Information.html#EXO-MAJOR-VERSION--CAPS" title="EXO_MAJOR_VERSION">EXO_MAJOR_VERSION</a>
 
66
#define             <a class="link" href="exo-Version-Information.html#EXO-MINOR-VERSION--CAPS" title="EXO_MINOR_VERSION">EXO_MINOR_VERSION</a>
 
67
#define             <a class="link" href="exo-Version-Information.html#EXO-MICRO-VERSION--CAPS" title="EXO_MICRO_VERSION">EXO_MICRO_VERSION</a>
 
68
#define             <a class="link" href="exo-Version-Information.html#EXO-CHECK-VERSION--CAPS" title="EXO_CHECK_VERSION()">EXO_CHECK_VERSION</a>                   (major,minor,micro)
75
69
</pre>
76
70
</div>
77
71
<div class="refsect1" lang="en">
95
89
</p>
96
90
<p>
97
91
This variable is in the library, and therefore represents the exo
98
 
library you have linked against. Contrast with the <a class="link" href="exo-Version-Information.html#EXO-MAJOR-VERSION:CAPS" title="EXO_MAJOR_VERSION"><span class="type">EXO_MAJOR_VERSION</span></a>
 
92
library you have linked against. Contrast with the <a class="link" href="exo-Version-Information.html#EXO-MAJOR-VERSION--CAPS" title="EXO_MAJOR_VERSION"><span class="type">EXO_MAJOR_VERSION</span></a>
99
93
macro, which represents the major version of the libexo headers
100
94
you have included.
101
95
</p>
111
105
</p>
112
106
<p>
113
107
This variable is in the library, and therefore represents the exo
114
 
library you have linked against. Contrast with the <a class="link" href="exo-Version-Information.html#EXO-MINOR-VERSION:CAPS" title="EXO_MINOR_VERSION"><span class="type">EXO_MINOR_VERSION</span></a>
 
108
library you have linked against. Contrast with the <a class="link" href="exo-Version-Information.html#EXO-MINOR-VERSION--CAPS" title="EXO_MINOR_VERSION"><span class="type">EXO_MINOR_VERSION</span></a>
115
109
macro, which represents the minor version of the libexo headers
116
110
you have included.
117
111
</p>
127
121
</p>
128
122
<p>
129
123
This variable is in the library, and therefore represents the exo
130
 
library you have linked against. Contrast with the <a class="link" href="exo-Version-Information.html#EXO-MICRO-VERSION:CAPS" title="EXO_MICRO_VERSION"><span class="type">EXO_MICRO_VERSION</span></a>
 
124
library you have linked against. Contrast with the <a class="link" href="exo-Version-Information.html#EXO-MICRO-VERSION--CAPS" title="EXO_MICRO_VERSION"><span class="type">EXO_MICRO_VERSION</span></a>
131
125
macro, which represents the micro version of the libexo headers
132
126
you have included.
133
127
</p>
135
129
<hr>
136
130
<div class="refsect2" lang="en">
137
131
<a name="exo-check-version"></a><h3>exo_check_version ()</h3>
138
 
<pre class="programlisting">const <a
139
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
140
 
>gchar</a>*        exo_check_version                   (<a
141
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
142
 
>guint</a> required_major,
143
 
                                                         <a
144
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
145
 
>guint</a> required_minor,
146
 
                                                         <a
147
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
148
 
>guint</a> required_micro);</pre>
 
132
<pre class="programlisting">const gchar *       exo_check_version                   (guint required_major,
 
133
                                                         guint required_minor,
 
134
                                                         guint required_micro);</pre>
149
135
<p>
150
136
Checks that the <code class="systemitem">exo</code> library
151
137
in use is compatible with the given version. Generally you would pass in
152
 
the constants <a class="link" href="exo-Version-Information.html#EXO-MAJOR-VERSION:CAPS" title="EXO_MAJOR_VERSION"><span class="type">EXO_MAJOR_VERSION</span></a>, <a class="link" href="exo-Version-Information.html#EXO-MINOR-VERSION:CAPS" title="EXO_MINOR_VERSION"><span class="type">EXO_MINOR_VERSION</span></a> and <a class="link" href="exo-Version-Information.html#EXO-MICRO-VERSION:CAPS" title="EXO_MICRO_VERSION"><span class="type">EXO_MICRO_VERSION</span></a>
 
138
the constants <a class="link" href="exo-Version-Information.html#EXO-MAJOR-VERSION--CAPS" title="EXO_MAJOR_VERSION"><span class="type">EXO_MAJOR_VERSION</span></a>, <a class="link" href="exo-Version-Information.html#EXO-MINOR-VERSION--CAPS" title="EXO_MINOR_VERSION"><span class="type">EXO_MINOR_VERSION</span></a> and <a class="link" href="exo-Version-Information.html#EXO-MICRO-VERSION--CAPS" title="EXO_MICRO_VERSION"><span class="type">EXO_MICRO_VERSION</span></a>
153
139
as the three arguments to this function; that produces
154
140
a check that the library in use is compatible with the version of
155
141
<code class="systemitem">exo</code> the application was
158
144
<p>
159
145
</p>
160
146
<div class="example">
161
 
<a name="id2906544"></a><p class="title"><b>Example 2. Checking the runtime version of the exo library</b></p>
 
147
<a name="id2846398"></a><p class="title"><b>Example 2. Checking the runtime version of the exo library</b></p>
162
148
<div class="example-contents"><pre class="programlisting">
163
149
const gchar *mismatch;
164
150
mismatch = exo_check_version (EXO_VERSION_MAJOR,
170
156
</div>
171
157
<p><br class="example-break"></p>
172
158
<p>
173
 
 
174
159
</p>
175
160
<div class="variablelist"><table border="0">
176
161
<col align="left" valign="top">
192
177
</tr>
193
178
<tr>
194
179
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
195
 
<td> <a
196
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
197
 
><code class="literal">NULL</code></a> if the library is compatible with the given version,
 
180
<td> <code class="literal">NULL</code> if the library is compatible with the given version,
198
181
              or a string describing the version mismatch. The returned
199
182
              string is owned by the library and must not be freed or
200
183
              modified by the caller.
203
186
</tr>
204
187
</tbody>
205
188
</table></div>
206
 
<p class="since">Since  0.3.1
207
 
</p>
 
189
<p class="since">Since 0.3.1</p>
208
190
</div>
209
191
<hr>
210
192
<div class="refsect2" lang="en">
211
 
<a name="EXO-MAJOR-VERSION:CAPS"></a><h3>EXO_MAJOR_VERSION</h3>
 
193
<a name="EXO-MAJOR-VERSION--CAPS"></a><h3>EXO_MAJOR_VERSION</h3>
212
194
<pre class="programlisting">#define             EXO_MAJOR_VERSION</pre>
213
195
<p>
214
196
Like <a class="link" href="exo-Version-Information.html#exo-major-version" title="exo_major_version"><span class="type">exo_major_version</span></a>, but from the headers used at application
218
200
</div>
219
201
<hr>
220
202
<div class="refsect2" lang="en">
221
 
<a name="EXO-MINOR-VERSION:CAPS"></a><h3>EXO_MINOR_VERSION</h3>
 
203
<a name="EXO-MINOR-VERSION--CAPS"></a><h3>EXO_MINOR_VERSION</h3>
222
204
<pre class="programlisting">#define             EXO_MINOR_VERSION</pre>
223
205
<p>
224
206
Like <a class="link" href="exo-Version-Information.html#exo-minor-version" title="exo_minor_version"><span class="type">exo_minor_version</span></a>, but from the headers used at application
228
210
</div>
229
211
<hr>
230
212
<div class="refsect2" lang="en">
231
 
<a name="EXO-MICRO-VERSION:CAPS"></a><h3>EXO_MICRO_VERSION</h3>
 
213
<a name="EXO-MICRO-VERSION--CAPS"></a><h3>EXO_MICRO_VERSION</h3>
232
214
<pre class="programlisting">#define             EXO_MICRO_VERSION</pre>
233
215
<p>
234
216
Like <a class="link" href="exo-Version-Information.html#exo-micro-version" title="exo_micro_version"><span class="type">exo_micro_version</span></a>, but from the headers used at application
238
220
</div>
239
221
<hr>
240
222
<div class="refsect2" lang="en">
241
 
<a name="EXO-CHECK-VERSION:CAPS"></a><h3>EXO_CHECK_VERSION()</h3>
 
223
<a name="EXO-CHECK-VERSION--CAPS"></a><h3>EXO_CHECK_VERSION()</h3>
242
224
<pre class="programlisting">#define             EXO_CHECK_VERSION(major,minor,micro)</pre>
243
225
<p>
244
 
Returns <a
245
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
246
 
><code class="literal">TRUE</code></a> if the version of the libexo header files is 
 
226
Returns <code class="literal">TRUE</code> if the version of the libexo header files is
247
227
equal or better than the passed-in version.
248
228
</p>
249
229
<div class="variablelist"><table border="0">
262
242
<tr>
263
243
<td><p><span class="term"><em class="parameter"><code>micro</code></em> :</span></p></td>
264
244
<td>micro version (e.g. 3 for version 0.1.3)
265
 
 
266
 
 
267
245
</td>
268
246
</tr>
269
247
</tbody>
273
251
</div>
274
252
<div class="footer">
275
253
<hr>
276
 
          Generated by GTK-Doc V1.10</div>
 
254
          Generated by GTK-Doc V1.11</div>
277
255
</body>
278
256
</html>