<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Apache Portable Runtime Utility Library: include/apu_version.h File Reference</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.4 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>include/apu_version.h File Reference</h1>APR-util Versioning Interface. <a href="#_details">More...</a> <p> <code>#include "apr_version.h"</code><br> <code>#include "apu.h"</code><br> <p> <a href="apu__version_8h-source.html">Go to the source code of this file.</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#c6ad13b6f97cfe3b3d9008ff34f0bb35">APU_MAJOR_VERSION</a> 1</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#28a5f6fb38453905a840885a8c00152a">APU_MINOR_VERSION</a> 2</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#44b4590b3763f9c92f9d429fb9ce119b">APU_PATCH_VERSION</a> 12</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#b47617bb2faf080300b78620a4a53a6c">APU_IS_DEV_STRING</a> "-dev"</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#18a778c91b4b029e21691b9f0fa85284">APU_STRINGIFY</a>(n) APU_STRINGIFY_HELPER(n)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#a2936265eef0c753fe6fe8ea9c81eec2">APU_STRINGIFY_HELPER</a>(n) #n</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#10c7d040b89f2aa014a57d574e5db3d1">APU_VERSION_STRING</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#0442a908106268fe88603f2c56388302">APU_VERSION_STRING_CSV</a></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#14cce37b5ee21096fc4307e7374a4970">apu_version</a> (apr_version_t *pvsn)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="apu__version_8h.html#50777ba300ca00840f7fce3bf6c1e917">apu_version_string</a> (void)</td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> APR-util Versioning Interface. <p> APR-util's Version<p> There are several different mechanisms for accessing the version. There is a string form, and a set of numbers; in addition, there are constants which can be compiled into your application, and you can query the library being used for its actual version.<p> Note that it is possible for an application to detect that it has been compiled against a different version of APU by use of the compile-time constants and the use of the run-time query function.<p> APU version numbering follows the guidelines specified in:<p> <a href="http://apr.apache.org/versioning.html">http://apr.apache.org/versioning.html</a> <hr><h2>Define Documentation</h2> <a class="anchor" name="b47617bb2faf080300b78620a4a53a6c"></a><!-- doxytag: member="apu_version.h::APU_IS_DEV_STRING" ref="b47617bb2faf080300b78620a4a53a6c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APU_IS_DEV_STRING "-dev" </td> </tr> </table> </div> <div class="memdoc"> <p> The symbol APU_IS_DEV_VERSION is only defined for internal, "development" copies of APU. It is undefined for released versions of APU. Internal: string form of the "is dev" flag </div> </div><p> <a class="anchor" name="c6ad13b6f97cfe3b3d9008ff34f0bb35"></a><!-- doxytag: member="apu_version.h::APU_MAJOR_VERSION" ref="c6ad13b6f97cfe3b3d9008ff34f0bb35" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APU_MAJOR_VERSION 1 </td> </tr> </table> </div> <div class="memdoc"> <p> major version Major API changes that could cause compatibility problems for older programs such as structure size changes. No binary compatibility is possible across a change in the major version. </div> </div><p> <a class="anchor" name="28a5f6fb38453905a840885a8c00152a"></a><!-- doxytag: member="apu_version.h::APU_MINOR_VERSION" ref="28a5f6fb38453905a840885a8c00152a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APU_MINOR_VERSION 2 </td> </tr> </table> </div> <div class="memdoc"> <p> minor version Minor API changes that do not cause binary compatibility problems. Reset to 0 when upgrading APU_MAJOR_VERSION </div> </div><p> <a class="anchor" name="44b4590b3763f9c92f9d429fb9ce119b"></a><!-- doxytag: member="apu_version.h::APU_PATCH_VERSION" ref="44b4590b3763f9c92f9d429fb9ce119b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APU_PATCH_VERSION 12 </td> </tr> </table> </div> <div class="memdoc"> <p> patch level The Patch Level never includes API changes, simply bug fixes. Reset to 0 when upgrading APR_MINOR_VERSION </div> </div><p> <a class="anchor" name="18a778c91b4b029e21691b9f0fa85284"></a><!-- doxytag: member="apu_version.h::APU_STRINGIFY" ref="18a778c91b4b029e21691b9f0fa85284" args="(n)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APU_STRINGIFY </td> <td>(</td> <td class="paramtype">n </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> APU_STRINGIFY_HELPER(n)</td> </tr> </table> </div> <div class="memdoc"> <p> Properly quote a value as a string in the C preprocessor </div> </div><p> <a class="anchor" name="a2936265eef0c753fe6fe8ea9c81eec2"></a><!-- doxytag: member="apu_version.h::APU_STRINGIFY_HELPER" ref="a2936265eef0c753fe6fe8ea9c81eec2" args="(n)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APU_STRINGIFY_HELPER </td> <td>(</td> <td class="paramtype">n </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> #n</td> </tr> </table> </div> <div class="memdoc"> <p> Helper macro for APU_STRINGIFY </div> </div><p> <a class="anchor" name="10c7d040b89f2aa014a57d574e5db3d1"></a><!-- doxytag: member="apu_version.h::APU_VERSION_STRING" ref="10c7d040b89f2aa014a57d574e5db3d1" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APU_VERSION_STRING </td> </tr> </table> </div> <div class="memdoc"> <p> <b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="apu__version_8h.html#18a778c91b4b029e21691b9f0fa85284">APU_STRINGIFY</a>(<a class="code" href="apu__version_8h.html#c6ad13b6f97cfe3b3d9008ff34f0bb35">APU_MAJOR_VERSION</a>) <span class="stringliteral">"."</span> \ <a class="code" href="apu__version_8h.html#18a778c91b4b029e21691b9f0fa85284">APU_STRINGIFY</a>(<a class="code" href="apu__version_8h.html#28a5f6fb38453905a840885a8c00152a">APU_MINOR_VERSION</a>) <span class="stringliteral">"."</span> \ <a class="code" href="apu__version_8h.html#18a778c91b4b029e21691b9f0fa85284">APU_STRINGIFY</a>(<a class="code" href="apu__version_8h.html#44b4590b3763f9c92f9d429fb9ce119b">APU_PATCH_VERSION</a>) \ <a class="code" href="apu__version_8h.html#b47617bb2faf080300b78620a4a53a6c">APU_IS_DEV_STRING</a> </pre></div>The formatted string of APU's version </div> </div><p> <a class="anchor" name="0442a908106268fe88603f2c56388302"></a><!-- doxytag: member="apu_version.h::APU_VERSION_STRING_CSV" ref="0442a908106268fe88603f2c56388302" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APU_VERSION_STRING_CSV </td> </tr> </table> </div> <div class="memdoc"> <p> <b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="apu__version_8h.html#c6ad13b6f97cfe3b3d9008ff34f0bb35">APU_MAJOR_VERSION</a> ##, \ <span class="preprocessor"> ##APU_MINOR_VERSION ##, \</span> <span class="preprocessor"> ##APU_PATCH_VERSION</span> </pre></div>An alternative formatted string of APR's version </div> </div><p> <hr><h2>Function Documentation</h2> <a class="anchor" name="14cce37b5ee21096fc4307e7374a4970"></a><!-- doxytag: member="apu_version.h::apu_version" ref="14cce37b5ee21096fc4307e7374a4970" args="(apr_version_t *pvsn)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void apu_version </td> <td>(</td> <td class="paramtype">apr_version_t * </td> <td class="paramname"> <em>pvsn</em> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Return APR-util's version information information in a numeric form.<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>pvsn</em> </td><td>Pointer to a version structure for returning the version information. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="50777ba300ca00840f7fce3bf6c1e917"></a><!-- doxytag: member="apu_version.h::apu_version_string" ref="50777ba300ca00840f7fce3bf6c1e917" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* apu_version_string </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> Return APU's version information as a string. </div> </div><p> <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 24 02:22:55 2008 for Apache Portable Runtime Utility Library by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address> </body> </html>