<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>libgutenprint API Reference: version</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libgutenprint API Reference  <span id="projectnumber">5.2.9</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> | <a href="#var-members">Variables</a> </div> <div class="headertitle"> <div class="title">version</div> </div> </div><!--header--> <div class="contents"> <p>Version information. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:gadd0b07630653da8e46b91c2c1bafc2b9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gadd0b07630653da8e46b91c2c1bafc2b9">STP_MAJOR_VERSION</a>   (5)</td></tr> <tr class="memitem:ga87507431ad6b7504b129eafad863cb1f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga87507431ad6b7504b129eafad863cb1f">STP_MINOR_VERSION</a>   (2)</td></tr> <tr class="memitem:gab860ee8cb0b05ea1385e01d130d7358e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gab860ee8cb0b05ea1385e01d130d7358e">STP_MICRO_VERSION</a>   (9)</td></tr> <tr class="memitem:ga1969d8a5a74a5c70a978f99aa68d9f4b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga1969d8a5a74a5c70a978f99aa68d9f4b">STP_CURRENT_INTERFACE</a>   (3)</td></tr> <tr class="memitem:ga509ecd9be5329eef0f8d49e0b25f63da"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga509ecd9be5329eef0f8d49e0b25f63da">STP_BINARY_AGE</a>   (1)</td></tr> <tr class="memitem:ga6485cd073e75e01f9df68ecd67b14372"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga6485cd073e75e01f9df68ecd67b14372">STP_INTERFACE_AGE</a>   (0)</td></tr> <tr class="memitem:gaf20320940416f43ed7735137296fa12b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gaf20320940416f43ed7735137296fa12b">STP_CHECK_VERSION</a>(major, minor, micro)</td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga05a93cb4ac52cc50875b5839c59bcafc"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga05a93cb4ac52cc50875b5839c59bcafc">stp_check_version</a> (unsigned int required_major, unsigned int required_minor, unsigned int required_micro)</td></tr> <tr class="memdesc:ga05a93cb4ac52cc50875b5839c59bcafc"><td class="mdescLeft"> </td><td class="mdescRight">Check whether the library provides the requested version. <a href="#ga05a93cb4ac52cc50875b5839c59bcafc"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="var-members"></a> Variables</h2></td></tr> <tr class="memitem:ga4d72666d9093df7a31e7cd448b7cfd1d"><td class="memItemLeft" align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga4d72666d9093df7a31e7cd448b7cfd1d">stp_major_version</a></td></tr> <tr class="memdesc:ga4d72666d9093df7a31e7cd448b7cfd1d"><td class="mdescLeft"> </td><td class="mdescRight">The library major version number. <a href="#ga4d72666d9093df7a31e7cd448b7cfd1d"></a><br/></td></tr> <tr class="memitem:ga5efc986430f0d27f5d11236c4bc48079"><td class="memItemLeft" align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga5efc986430f0d27f5d11236c4bc48079">stp_minor_version</a></td></tr> <tr class="memdesc:ga5efc986430f0d27f5d11236c4bc48079"><td class="mdescLeft"> </td><td class="mdescRight">The library minor version number. <a href="#ga5efc986430f0d27f5d11236c4bc48079"></a><br/></td></tr> <tr class="memitem:ga2c7e65e276ce5af050b3ea9f859f1f89"><td class="memItemLeft" align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga2c7e65e276ce5af050b3ea9f859f1f89">stp_micro_version</a></td></tr> <tr class="memdesc:ga2c7e65e276ce5af050b3ea9f859f1f89"><td class="mdescLeft"> </td><td class="mdescRight">The library micro version number. <a href="#ga2c7e65e276ce5af050b3ea9f859f1f89"></a><br/></td></tr> <tr class="memitem:gafc84e89ce8d6d3302270c56ebe01d5ef"><td class="memItemLeft" align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#gafc84e89ce8d6d3302270c56ebe01d5ef">stp_current_interface</a></td></tr> <tr class="memdesc:gafc84e89ce8d6d3302270c56ebe01d5ef"><td class="mdescLeft"> </td><td class="mdescRight">The library ABI revision number (number of incompatible revisions). <a href="#gafc84e89ce8d6d3302270c56ebe01d5ef"></a><br/></td></tr> <tr class="memitem:ga44593f7714544c5886ab34521e05d0bd"><td class="memItemLeft" align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga44593f7714544c5886ab34521e05d0bd">stp_binary_age</a></td></tr> <tr class="memdesc:ga44593f7714544c5886ab34521e05d0bd"><td class="mdescLeft"> </td><td class="mdescRight">The library ABI binary age number (number of forward-compatible revisions). <a href="#ga44593f7714544c5886ab34521e05d0bd"></a><br/></td></tr> <tr class="memitem:ga1284e8ef76a4c864e85b7b698b91bf0c"><td class="memItemLeft" align="right" valign="top">const unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__version.html#ga1284e8ef76a4c864e85b7b698b91bf0c">stp_interface_age</a></td></tr> <tr class="memdesc:ga1284e8ef76a4c864e85b7b698b91bf0c"><td class="mdescLeft"> </td><td class="mdescRight">The library ABI interface age number (number of revisions of this ABI). <a href="#ga1284e8ef76a4c864e85b7b698b91bf0c"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <p>Version information. </p> <p>Version information may be used to check the library version at compile-time, using macros, or at run-time, using constants. </p> <hr/><h2>Macro Definition Documentation</h2> <a class="anchor" id="ga509ecd9be5329eef0f8d49e0b25f63da"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define STP_BINARY_AGE   (1)</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="gaf20320940416f43ed7735137296fa12b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define STP_CHECK_VERSION</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">major, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">minor, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">micro </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <b>Value:</b><div class="fragment"><div class="line">(<a class="code" href="group__version.html#gadd0b07630653da8e46b91c2c1bafc2b9">STP_MAJOR_VERSION</a> > (major) || \</div> <div class="line"> (<a class="code" href="group__version.html#gadd0b07630653da8e46b91c2c1bafc2b9">STP_MAJOR_VERSION</a> == (major) && \</div> <div class="line"> STP_MINOR_VERSION > (minor)) || \</div> <div class="line"> (<a class="code" href="group__version.html#gadd0b07630653da8e46b91c2c1bafc2b9">STP_MAJOR_VERSION</a> == (major) && \</div> <div class="line"> <a class="code" href="group__version.html#ga87507431ad6b7504b129eafad863cb1f">STP_MINOR_VERSION</a> == (minor) && \</div> <div class="line"> STP_MICRO_VERSION >= (micro)))</div> </div><!-- fragment --> </div> </div> <a class="anchor" id="ga1969d8a5a74a5c70a978f99aa68d9f4b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define STP_CURRENT_INTERFACE   (3)</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ga6485cd073e75e01f9df68ecd67b14372"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define STP_INTERFACE_AGE   (0)</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="gadd0b07630653da8e46b91c2c1bafc2b9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define STP_MAJOR_VERSION   (5)</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="gab860ee8cb0b05ea1385e01d130d7358e"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define STP_MICRO_VERSION   (9)</td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="ga87507431ad6b7504b129eafad863cb1f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define STP_MINOR_VERSION   (2)</td> </tr> </table> </div><div class="memdoc"> </div> </div> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ga05a93cb4ac52cc50875b5839c59bcafc"></a> <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 </td> <td class="paramname"><em>required_major</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>required_minor</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"><em>required_micro</em> </td> </tr> <tr> <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 class="params"><dt>Parameters:</dt><dd> <table class="params"> <tr><td class="paramname">required_major</td><td>the minimum major revision. </td></tr> <tr><td class="paramname">required_minor</td><td>the minimum minor revision. </td></tr> <tr><td class="paramname">required_micro</td><td>the minimum micro revision. </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns:</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> <hr/><h2>Variable Documentation</h2> <a class="anchor" id="ga44593f7714544c5886ab34521e05d0bd"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const unsigned int stp_binary_age</td> </tr> </table> </div><div class="memdoc"> <p>The library ABI binary age number (number of forward-compatible revisions). </p> </div> </div> <a class="anchor" id="gafc84e89ce8d6d3302270c56ebe01d5ef"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const unsigned int stp_current_interface</td> </tr> </table> </div><div class="memdoc"> <p>The library ABI revision number (number of incompatible revisions). </p> </div> </div> <a class="anchor" id="ga1284e8ef76a4c864e85b7b698b91bf0c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const unsigned int stp_interface_age</td> </tr> </table> </div><div class="memdoc"> <p>The library ABI interface age number (number of revisions of this ABI). </p> </div> </div> <a class="anchor" id="ga4d72666d9093df7a31e7cd448b7cfd1d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const unsigned int stp_major_version</td> </tr> </table> </div><div class="memdoc"> <p>The library major version number. </p> </div> </div> <a class="anchor" id="ga2c7e65e276ce5af050b3ea9f859f1f89"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const unsigned int stp_micro_version</td> </tr> </table> </div><div class="memdoc"> <p>The library micro version number. </p> </div> </div> <a class="anchor" id="ga5efc986430f0d27f5d11236c4bc48079"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const unsigned int stp_minor_version</td> </tr> </table> </div><div class="memdoc"> <p>The library minor version number. </p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.1 </small></address> </body> </html>