summaryrefslogtreecommitdiff
path: root/doc/gutenprint/html/group__version.html
blob: 26b12df290e6887732a8bc6ff3682d967c6fa2e0 (plain)
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libgutenprint API Reference: version</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>version</h1>Version information.  
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gdd0b07630653da8e46b91c2c1bafc2b9">STP_MAJOR_VERSION</a>&nbsp;&nbsp;&nbsp;(5)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g87507431ad6b7504b129eafad863cb1f">STP_MINOR_VERSION</a>&nbsp;&nbsp;&nbsp;(2)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gb860ee8cb0b05ea1385e01d130d7358e">STP_MICRO_VERSION</a>&nbsp;&nbsp;&nbsp;(4)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g1969d8a5a74a5c70a978f99aa68d9f4b">STP_CURRENT_INTERFACE</a>&nbsp;&nbsp;&nbsp;(2)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g509ecd9be5329eef0f8d49e0b25f63da">STP_BINARY_AGE</a>&nbsp;&nbsp;&nbsp;(0)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g6485cd073e75e01f9df68ecd67b14372">STP_INTERFACE_AGE</a>&nbsp;&nbsp;&nbsp;(5)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gf20320940416f43ed7735137296fa12b">STP_CHECK_VERSION</a>(major, minor, micro)</td></tr>

<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g05a93cb4ac52cc50875b5839c59bcafc">stp_check_version</a> (unsigned int required_major, unsigned int required_minor, unsigned int required_micro)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check whether the library provides the requested version.  <a href="#g05a93cb4ac52cc50875b5839c59bcafc"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g4d72666d9093df7a31e7cd448b7cfd1d">stp_major_version</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The library major version number.  <a href="#g4d72666d9093df7a31e7cd448b7cfd1d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g5efc986430f0d27f5d11236c4bc48079">stp_minor_version</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The library minor version number.  <a href="#g5efc986430f0d27f5d11236c4bc48079"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g2c7e65e276ce5af050b3ea9f859f1f89">stp_micro_version</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The library micro version number.  <a href="#g2c7e65e276ce5af050b3ea9f859f1f89"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gfc84e89ce8d6d3302270c56ebe01d5ef">stp_current_interface</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The library ABI revision number (number of incompatible revisions).  <a href="#gfc84e89ce8d6d3302270c56ebe01d5ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g44593f7714544c5886ab34521e05d0bd">stp_binary_age</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The library ABI binary age number (number of forward-compatible revisions).  <a href="#g44593f7714544c5886ab34521e05d0bd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#g1284e8ef76a4c864e85b7b698b91bf0c">stp_interface_age</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The library ABI interface age number (number of revisions of this ABI).  <a href="#g1284e8ef76a4c864e85b7b698b91bf0c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Version information. 
<p>
Version information may be used to check the library version at compile-time, using macros, or at run-time, using constants. <hr><h2>Define Documentation</h2>
<a class="anchor" name="g509ecd9be5329eef0f8d49e0b25f63da"></a><!-- doxytag: member="gutenprint-version.h::STP_BINARY_AGE" ref="g509ecd9be5329eef0f8d49e0b25f63da" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STP_BINARY_AGE&nbsp;&nbsp;&nbsp;(0)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="gf20320940416f43ed7735137296fa12b"></a><!-- doxytag: member="gutenprint-version.h::STP_CHECK_VERSION" ref="gf20320940416f43ed7735137296fa12b" args="(major, minor, micro)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STP_CHECK_VERSION          </td>
          <td>(</td>
          <td class="paramtype">major,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">minor,         <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">micro&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<b>Value:</b><div class="fragment"><pre class="fragment">(<a class="code" href="group__version.html#gdd0b07630653da8e46b91c2c1bafc2b9">STP_MAJOR_VERSION</a> &gt;  (major) ||                \
  (<a class="code" href="group__version.html#gdd0b07630653da8e46b91c2c1bafc2b9">STP_MAJOR_VERSION</a> == (major) &amp;&amp;              \
   <a class="code" href="group__version.html#g87507431ad6b7504b129eafad863cb1f">STP_MINOR_VERSION</a> &gt; (minor)) ||              \
  (<a class="code" href="group__version.html#gdd0b07630653da8e46b91c2c1bafc2b9">STP_MAJOR_VERSION</a> == (major) &amp;&amp;              \
   <a class="code" href="group__version.html#g87507431ad6b7504b129eafad863cb1f">STP_MINOR_VERSION</a> == (minor) &amp;&amp;              \
   <a class="code" href="group__version.html#gb860ee8cb0b05ea1385e01d130d7358e">STP_MICRO_VERSION</a> &gt;= (micro)))
</pre></div>
</div>
</div><p>
<a class="anchor" name="g1969d8a5a74a5c70a978f99aa68d9f4b"></a><!-- doxytag: member="gutenprint-version.h::STP_CURRENT_INTERFACE" ref="g1969d8a5a74a5c70a978f99aa68d9f4b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STP_CURRENT_INTERFACE&nbsp;&nbsp;&nbsp;(2)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="g6485cd073e75e01f9df68ecd67b14372"></a><!-- doxytag: member="gutenprint-version.h::STP_INTERFACE_AGE" ref="g6485cd073e75e01f9df68ecd67b14372" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STP_INTERFACE_AGE&nbsp;&nbsp;&nbsp;(5)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="gdd0b07630653da8e46b91c2c1bafc2b9"></a><!-- doxytag: member="gutenprint-version.h::STP_MAJOR_VERSION" ref="gdd0b07630653da8e46b91c2c1bafc2b9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STP_MAJOR_VERSION&nbsp;&nbsp;&nbsp;(5)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="gb860ee8cb0b05ea1385e01d130d7358e"></a><!-- doxytag: member="gutenprint-version.h::STP_MICRO_VERSION" ref="gb860ee8cb0b05ea1385e01d130d7358e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STP_MICRO_VERSION&nbsp;&nbsp;&nbsp;(4)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="g87507431ad6b7504b129eafad863cb1f"></a><!-- doxytag: member="gutenprint-version.h::STP_MINOR_VERSION" ref="g87507431ad6b7504b129eafad863cb1f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define STP_MINOR_VERSION&nbsp;&nbsp;&nbsp;(2)          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g05a93cb4ac52cc50875b5839c59bcafc"></a><!-- doxytag: member="gutenprint-version.h::stp_check_version" ref="g05a93cb4ac52cc50875b5839c59bcafc" args="(unsigned int required_major, unsigned int required_minor, unsigned int required_micro)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* stp_check_version           </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>required_major</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>required_minor</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>required_micro</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check whether the library provides the requested version. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>required_major</em>&nbsp;</td><td>the minimum major revision. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>required_minor</em>&nbsp;</td><td>the minimum minor revision. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>required_micro</em>&nbsp;</td><td>the minimum micro revision. </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL if the version matches, or else a description of the error if the library is too old or too new. </dd></dl>

</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="g44593f7714544c5886ab34521e05d0bd"></a><!-- doxytag: member="gutenprint-version.h::stp_binary_age" ref="g44593f7714544c5886ab34521e05d0bd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="group__version.html#g44593f7714544c5886ab34521e05d0bd">stp_binary_age</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The library ABI binary age number (number of forward-compatible revisions). 
<p>

</div>
</div><p>
<a class="anchor" name="gfc84e89ce8d6d3302270c56ebe01d5ef"></a><!-- doxytag: member="gutenprint-version.h::stp_current_interface" ref="gfc84e89ce8d6d3302270c56ebe01d5ef" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="group__version.html#gfc84e89ce8d6d3302270c56ebe01d5ef">stp_current_interface</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The library ABI revision number (number of incompatible revisions). 
<p>

</div>
</div><p>
<a class="anchor" name="g1284e8ef76a4c864e85b7b698b91bf0c"></a><!-- doxytag: member="gutenprint-version.h::stp_interface_age" ref="g1284e8ef76a4c864e85b7b698b91bf0c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="group__version.html#g1284e8ef76a4c864e85b7b698b91bf0c">stp_interface_age</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The library ABI interface age number (number of revisions of this ABI). 
<p>

</div>
</div><p>
<a class="anchor" name="g4d72666d9093df7a31e7cd448b7cfd1d"></a><!-- doxytag: member="gutenprint-version.h::stp_major_version" ref="g4d72666d9093df7a31e7cd448b7cfd1d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="group__version.html#g4d72666d9093df7a31e7cd448b7cfd1d">stp_major_version</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The library major version number. 
<p>

</div>
</div><p>
<a class="anchor" name="g2c7e65e276ce5af050b3ea9f859f1f89"></a><!-- doxytag: member="gutenprint-version.h::stp_micro_version" ref="g2c7e65e276ce5af050b3ea9f859f1f89" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="group__version.html#g2c7e65e276ce5af050b3ea9f859f1f89">stp_micro_version</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The library micro version number. 
<p>

</div>
</div><p>
<a class="anchor" name="g5efc986430f0d27f5d11236c4bc48079"></a><!-- doxytag: member="gutenprint-version.h::stp_minor_version" ref="g5efc986430f0d27f5d11236c4bc48079" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const unsigned int <a class="el" href="group__version.html#g5efc986430f0d27f5d11236c4bc48079">stp_minor_version</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The library minor version number. 
<p>

</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 16:37:28 2009 for libgutenprint API Reference by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>