b1cf0bb6fca93d2953f3e294b00f4efcebc9de61
[platform/upstream/glib2.0.git] / docs / reference / glib / tmpl / version.sgml
1 <!-- ##### SECTION Title ##### -->
2 Version Information
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Variables and functions to check the GLib version
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 GLib provides version information, primarily useful in configure checks
10 for builds that have a configure script. Applications will not
11 typically use the features described here.
12 </para>
13
14 <!-- ##### SECTION See_Also ##### -->
15 <para>
16
17 </para>
18
19 <!-- ##### SECTION Stability_Level ##### -->
20
21
22 <!-- ##### MACRO GLIB_MAJOR_VERSION ##### -->
23 <para>
24 The major version number of the GLib library.
25 Like #glib_major_version, but from the headers used at
26 application compile time, rather than from the library linked against
27 at application run time.
28 </para>
29
30
31
32 <!-- ##### MACRO GLIB_MINOR_VERSION ##### -->
33 <para>
34 The minor version number of the GLib library.
35 Like #gtk_minor_version, but from the headers used at
36 application compile time, rather than from the library linked against
37 at application run time.
38 </para>
39
40
41
42 <!-- ##### MACRO GLIB_MICRO_VERSION ##### -->
43 <para>
44 The micro version number of the GLib library.
45 Like #gtk_micro_version, but from the headers used at
46 application compile time, rather than from the library linked against
47 at application run time.
48 </para>
49
50
51
52 <!-- ##### MACRO GLIB_CHECK_VERSION ##### -->
53 <para>
54 Checks the version of the GLib library.
55 Returns %TRUE if the version of the GLib header files is the same 
56 as or newer than the passed-in version.
57
58 <example>
59 <title>Checking the version of the GLib library</title>
60 <programlisting>
61   if (!GLIB_CHECK_VERSION (1, 2, 0))
62     g_error ("GLib version 1.2.0 or above is needed");
63 </programlisting>
64 </example>
65 </para>
66
67 @major: the major version number.
68 @minor: the minor version number.
69 @micro: the micro version number.
70
71