File: libgxps-Version-Information.html

package info (click to toggle)
libgxps 0.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,168 kB
  • sloc: ansic: 10,622; xml: 999; sh: 18; makefile: 15
file content (161 lines) | stat: -rw-r--r-- 7,033 bytes parent folder | download 
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
 
<!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: GXPS Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GXPS Reference Manual">
<link rel="up" href="ch01.html" title="GXPS">
<link rel="prev" href="libgxps-GXPSError.html" title="GXPSError">
<link rel="next" href="api-index-full.html" title="Index of all symbols">
<meta name="generator" content="GTK-Doc V1.29.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgxps-Version-Information.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgxps-GXPSError.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgxps-Version-Information"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgxps-Version-Information.top_of_page"></a>Version Information</span></h2>
<p>Version Information — Variables and functions to check the GXPS version</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgxps-Version-Information.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libgxps-Version-Information.html#GXPS-CHECK-VERSION:CAPS" title="GXPS_CHECK_VERSION()">GXPS_CHECK_VERSION</a><span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgxps-Version-Information.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgxps-Version-Information.html#GXPS-MAJOR-VERSION:CAPS" title="GXPS_MAJOR_VERSION">GXPS_MAJOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgxps-Version-Information.html#GXPS-MINOR-VERSION:CAPS" title="GXPS_MINOR_VERSION">GXPS_MINOR_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgxps-Version-Information.html#GXPS-MICRO-VERSION:CAPS" title="GXPS_MICRO_VERSION">GXPS_MICRO_VERSION</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libgxps-Version-Information.html#GXPS-VERSION-STRING:CAPS" title="GXPS_VERSION_STRING">GXPS_VERSION_STRING</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgxps-Version-Information.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libgxps/gxps.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libgxps-Version-Information.description"></a><h2>Description</h2>
<p>GXPS provides version information, primarily useful in configure checks
for builds that have a configure script. Applications will not typically
use the features described here.</p>
</div>
<div class="refsect1">
<a name="libgxps-Version-Information.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GXPS-CHECK-VERSION:CAPS"></a><h3>GXPS_CHECK_VERSION()</h3>
<pre class="programlisting">#define             GXPS_CHECK_VERSION(major,minor,micro)</pre>
<p>Checks the version fo the GXPS library</p>
<div class="refsect3">
<a name="GXPS-CHECK-VERSION.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>major version (e.g. 0 for version 0.1.2)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>minor version (e.g. 1 for version 0.1.2)</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>micro</p></td>
<td class="parameter_description"><p>micro version (e.g. 2 for version 0.1.2)</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GXPS-CHECK-VERSION.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the version of the GXPS header files is the same
as or newer than the passed-in version</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libgxps-Version-Information.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GXPS-MAJOR-VERSION:CAPS"></a><h3>GXPS_MAJOR_VERSION</h3>
<pre class="programlisting">#define             GXPS_MAJOR_VERSION</pre>
<p>The major version number of the GXPS header files (e.g. in GXPS version
0.1.2 this is 0.)</p>
</div>
<hr>
<div class="refsect2">
<a name="GXPS-MINOR-VERSION:CAPS"></a><h3>GXPS_MINOR_VERSION</h3>
<pre class="programlisting">#define             GXPS_MINOR_VERSION</pre>
<p>The major version number of the GXPS header files (e.g. in GXPS version
0.1.2 this is 1.)</p>
</div>
<hr>
<div class="refsect2">
<a name="GXPS-MICRO-VERSION:CAPS"></a><h3>GXPS_MICRO_VERSION</h3>
<pre class="programlisting">#define             GXPS_MICRO_VERSION</pre>
<p>The micro version number of the GXPS header files (e.g. in GXPS version
0.1.2 this is 2.)</p>
</div>
<hr>
<div class="refsect2">
<a name="GXPS-VERSION-STRING:CAPS"></a><h3>GXPS_VERSION_STRING</h3>
<pre class="programlisting">#define             GXPS_VERSION_STRING</pre>
<p>The version number of the GXPS library as a string</p>
<p class="since">Since: <a class="link" href="api-index-0-2-1.html#api-index-0.2.1">0.2.1</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29.1</div>
</body>
</html>