| 1 |
<html> |
| 2 |
<head> |
| 3 |
<link rel="stylesheet" type="text/css" href="dox.css" /> |
| 4 |
<title>libapreq2-2.17: include/apreq_version.h File Reference</title> |
| 5 |
</head> |
| 6 |
<body> |
| 7 |
<div id="page-header"> |
| 8 |
<p class="menu"> |
| 9 |
<a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> > |
| 10 |
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p> |
| 11 |
<p class="apache">Apache HTTP Server Request Library</p> |
| 12 |
<img alt="" src="feather.gif" /></div> |
| 13 |
<!-- Generated by Doxygen 1.9.1 --> |
| 14 |
<script type="text/javascript" src="menudata.js"></script> |
| 15 |
<script type="text/javascript" src="menu.js"></script> |
| 16 |
<script type="text/javascript"> |
| 17 |
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| 18 |
$(function() { |
| 19 |
initMenu('',false,false,'search.php','Search'); |
| 20 |
}); |
| 21 |
/* @license-end */</script> |
| 22 |
<div id="main-nav"></div> |
| 23 |
<div id="nav-path" class="navpath"> |
| 24 |
<ul> |
| 25 |
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul> |
| 26 |
</div> |
| 27 |
</div><!-- top --> |
| 28 |
<div class="header"> |
| 29 |
<div class="summary"> |
| 30 |
<a href="#define-members">Macros</a> | |
| 31 |
<a href="#func-members">Functions</a> </div> |
| 32 |
<div class="headertitle"> |
| 33 |
<div class="title">apreq_version.h File Reference<div class="ingroups"><a class="el" href="group__libapreq2.html">Apache Request Library</a></div></div> </div> |
| 34 |
</div><!--header--> |
| 35 |
<div class="contents"> |
| 36 |
|
| 37 |
<p>Versioning API for libapreq. |
| 38 |
<a href="#details">More...</a></p> |
| 39 |
<div class="textblock"><code>#include "apr_version.h"</code><br /> |
| 40 |
<code>#include "<a class="el" href="apreq_8h_source.html">apreq.h</a>"</code><br /> |
| 41 |
</div> |
| 42 |
<p><a href="apreq__version_8h_source.html">Go to the source code of this file.</a></p> |
| 43 |
<table class="memberdecls"> |
| 44 |
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| 45 |
Macros</h2></td></tr> |
| 46 |
<tr class="memitem:a7fb04b0c2a9da6237e235b845ee89f9a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__version_8h.html#a7fb04b0c2a9da6237e235b845ee89f9a">APREQ_MAJOR_VERSION</a>   2</td></tr> |
| 47 |
<tr class="separator:a7fb04b0c2a9da6237e235b845ee89f9a"><td class="memSeparator" colspan="2"> </td></tr> |
| 48 |
<tr class="memitem:a44bf530fbecff4ee7bcc0158784da0ff"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__version_8h.html#a44bf530fbecff4ee7bcc0158784da0ff">APREQ_MINOR_VERSION</a>   8</td></tr> |
| 49 |
<tr class="separator:a44bf530fbecff4ee7bcc0158784da0ff"><td class="memSeparator" colspan="2"> </td></tr> |
| 50 |
<tr class="memitem:a365b89d742846921cb3619341e5eb266"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__version_8h.html#a365b89d742846921cb3619341e5eb266">APREQ_PATCH_VERSION</a>   1</td></tr> |
| 51 |
<tr class="separator:a365b89d742846921cb3619341e5eb266"><td class="memSeparator" colspan="2"> </td></tr> |
| 52 |
<tr class="memitem:add82c8ea79b8cc142eeec45772d24fdb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__version_8h.html#add82c8ea79b8cc142eeec45772d24fdb">APREQ_VERSION_STRING</a></td></tr> |
| 53 |
<tr class="separator:add82c8ea79b8cc142eeec45772d24fdb"><td class="memSeparator" colspan="2"> </td></tr> |
| 54 |
<tr class="memitem:ac9445f3e18e852cae2a91bd2a63394be"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__version_8h.html#ac9445f3e18e852cae2a91bd2a63394be">APREQ_IS_DEV_STRING</a>   ""</td></tr> |
| 55 |
<tr class="separator:ac9445f3e18e852cae2a91bd2a63394be"><td class="memSeparator" colspan="2"> </td></tr> |
| 56 |
</table><table class="memberdecls"> |
| 57 |
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| 58 |
Functions</h2></td></tr> |
| 59 |
<tr class="memitem:a8d20db97717fa1bad4f31c7f9a29594f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__version_8h.html#a8d20db97717fa1bad4f31c7f9a29594f">apreq_version</a> (apr_version_t *pvsn)</td></tr> |
| 60 |
<tr class="separator:a8d20db97717fa1bad4f31c7f9a29594f"><td class="memSeparator" colspan="2"> </td></tr> |
| 61 |
<tr class="memitem:a663ea74082d9bbe18a0c15b66b8fddaa"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__version_8h.html#a663ea74082d9bbe18a0c15b66b8fddaa">apreq_version_string</a> (void)</td></tr> |
| 62 |
<tr class="separator:a663ea74082d9bbe18a0c15b66b8fddaa"><td class="memSeparator" colspan="2"> </td></tr> |
| 63 |
</table> |
| 64 |
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 65 |
<div class="textblock"><p>Versioning API for libapreq. </p> |
| 66 |
<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> |
| 67 |
<p>Note that it is possible for an application to detect that it has been compiled against a different version of libapreq by use of the compile-time constants and the use of the run-time query function.</p> |
| 68 |
<p>libapreq version numbering follows the guidelines specified in: </p><pre class="fragment">http://apr.apache.org/versioning.html |
| 69 |
</pre> </div><h2 class="groupheader">Macro Definition Documentation</h2> |
| 70 |
<a id="ac9445f3e18e852cae2a91bd2a63394be"></a> |
| 71 |
<h2 class="memtitle"><span class="permalink"><a href="#ac9445f3e18e852cae2a91bd2a63394be">◆ </a></span>APREQ_IS_DEV_STRING</h2> |
| 72 |
|
| 73 |
<div class="memitem"> |
| 74 |
<div class="memproto"> |
| 75 |
<table class="memname"> |
| 76 |
<tr> |
| 77 |
<td class="memname">#define APREQ_IS_DEV_STRING   ""</td> |
| 78 |
</tr> |
| 79 |
</table> |
| 80 |
</div><div class="memdoc"> |
| 81 |
<p>Internal: string form of the "is dev" flag </p> |
| 82 |
|
| 83 |
</div> |
| 84 |
</div> |
| 85 |
<a id="a7fb04b0c2a9da6237e235b845ee89f9a"></a> |
| 86 |
<h2 class="memtitle"><span class="permalink"><a href="#a7fb04b0c2a9da6237e235b845ee89f9a">◆ </a></span>APREQ_MAJOR_VERSION</h2> |
| 87 |
|
| 88 |
<div class="memitem"> |
| 89 |
<div class="memproto"> |
| 90 |
<table class="memname"> |
| 91 |
<tr> |
| 92 |
<td class="memname">#define APREQ_MAJOR_VERSION   2</td> |
| 93 |
</tr> |
| 94 |
</table> |
| 95 |
</div><div class="memdoc"> |
| 96 |
<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. </p> |
| 97 |
|
| 98 |
</div> |
| 99 |
</div> |
| 100 |
<a id="a44bf530fbecff4ee7bcc0158784da0ff"></a> |
| 101 |
<h2 class="memtitle"><span class="permalink"><a href="#a44bf530fbecff4ee7bcc0158784da0ff">◆ </a></span>APREQ_MINOR_VERSION</h2> |
| 102 |
|
| 103 |
<div class="memitem"> |
| 104 |
<div class="memproto"> |
| 105 |
<table class="memname"> |
| 106 |
<tr> |
| 107 |
<td class="memname">#define APREQ_MINOR_VERSION   8</td> |
| 108 |
</tr> |
| 109 |
</table> |
| 110 |
</div><div class="memdoc"> |
| 111 |
<p>Minor API changes that do not cause binary compatibility problems. Should be reset to 0 when upgrading APREQ_MAJOR_VERSION </p> |
| 112 |
|
| 113 |
</div> |
| 114 |
</div> |
| 115 |
<a id="a365b89d742846921cb3619341e5eb266"></a> |
| 116 |
<h2 class="memtitle"><span class="permalink"><a href="#a365b89d742846921cb3619341e5eb266">◆ </a></span>APREQ_PATCH_VERSION</h2> |
| 117 |
|
| 118 |
<div class="memitem"> |
| 119 |
<div class="memproto"> |
| 120 |
<table class="memname"> |
| 121 |
<tr> |
| 122 |
<td class="memname">#define APREQ_PATCH_VERSION   1</td> |
| 123 |
</tr> |
| 124 |
</table> |
| 125 |
</div><div class="memdoc"> |
| 126 |
<p>patch level </p> |
| 127 |
|
| 128 |
</div> |
| 129 |
</div> |
| 130 |
<a id="add82c8ea79b8cc142eeec45772d24fdb"></a> |
| 131 |
<h2 class="memtitle"><span class="permalink"><a href="#add82c8ea79b8cc142eeec45772d24fdb">◆ </a></span>APREQ_VERSION_STRING</h2> |
| 132 |
|
| 133 |
<div class="memitem"> |
| 134 |
<div class="memproto"> |
| 135 |
<table class="memname"> |
| 136 |
<tr> |
| 137 |
<td class="memname">#define APREQ_VERSION_STRING</td> |
| 138 |
</tr> |
| 139 |
</table> |
| 140 |
</div><div class="memdoc"> |
| 141 |
<b>Value:</b><div class="fragment"><div class="line"> APR_STRINGIFY(<a class="code" href="apreq__version_8h.html#a7fb04b0c2a9da6237e235b845ee89f9a">APREQ_MAJOR_VERSION</a>) <span class="stringliteral">"."</span> \</div> |
| 142 |
<div class="line"> APR_STRINGIFY(<a class="code" href="apreq__version_8h.html#a44bf530fbecff4ee7bcc0158784da0ff">APREQ_MINOR_VERSION</a>) <span class="stringliteral">"."</span> \</div> |
| 143 |
<div class="line"> APR_STRINGIFY(<a class="code" href="apreq__version_8h.html#a365b89d742846921cb3619341e5eb266">APREQ_PATCH_VERSION</a>) \</div> |
| 144 |
<div class="line"> APREQ_IS_DEV_STRING</div> |
| 145 |
<div class="ttc" id="aapreq__version_8h_html_a365b89d742846921cb3619341e5eb266"><div class="ttname"><a href="apreq__version_8h.html#a365b89d742846921cb3619341e5eb266">APREQ_PATCH_VERSION</a></div><div class="ttdeci">#define APREQ_PATCH_VERSION</div><div class="ttdef"><b>Definition:</b> apreq_version.h:65</div></div> |
| 146 |
<div class="ttc" id="aapreq__version_8h_html_a44bf530fbecff4ee7bcc0158784da0ff"><div class="ttname"><a href="apreq__version_8h.html#a44bf530fbecff4ee7bcc0158784da0ff">APREQ_MINOR_VERSION</a></div><div class="ttdeci">#define APREQ_MINOR_VERSION</div><div class="ttdef"><b>Definition:</b> apreq_version.h:62</div></div> |
| 147 |
<div class="ttc" id="aapreq__version_8h_html_a7fb04b0c2a9da6237e235b845ee89f9a"><div class="ttname"><a href="apreq__version_8h.html#a7fb04b0c2a9da6237e235b845ee89f9a">APREQ_MAJOR_VERSION</a></div><div class="ttdeci">#define APREQ_MAJOR_VERSION</div><div class="ttdef"><b>Definition:</b> apreq_version.h:56</div></div> |
| 148 |
</div><!-- fragment --><p>This symbol is defined for internal, "development" copies of libapreq. This symbol will be #undef'd for releases. The formatted string of libapreq's version </p> |
| 149 |
|
| 150 |
</div> |
| 151 |
</div> |
| 152 |
<h2 class="groupheader">Function Documentation</h2> |
| 153 |
<a id="a8d20db97717fa1bad4f31c7f9a29594f"></a> |
| 154 |
<h2 class="memtitle"><span class="permalink"><a href="#a8d20db97717fa1bad4f31c7f9a29594f">◆ </a></span>apreq_version()</h2> |
| 155 |
|
| 156 |
<div class="memitem"> |
| 157 |
<div class="memproto"> |
| 158 |
<table class="memname"> |
| 159 |
<tr> |
| 160 |
<td class="memname">void apreq_version </td> |
| 161 |
<td>(</td> |
| 162 |
<td class="paramtype">apr_version_t * </td> |
| 163 |
<td class="paramname"><em>pvsn</em></td><td>)</td> |
| 164 |
<td></td> |
| 165 |
</tr> |
| 166 |
</table> |
| 167 |
</div><div class="memdoc"> |
| 168 |
<p>Return libapreq's version information information in a numeric form.</p> |
| 169 |
<dl class="params"><dt>Parameters</dt><dd> |
| 170 |
<table class="params"> |
| 171 |
<tr><td class="paramname">pvsn</td><td>Pointer to a version structure for returning the version information. </td></tr> |
| 172 |
</table> |
| 173 |
</dd> |
| 174 |
</dl> |
| 175 |
|
| 176 |
</div> |
| 177 |
</div> |
| 178 |
<a id="a663ea74082d9bbe18a0c15b66b8fddaa"></a> |
| 179 |
<h2 class="memtitle"><span class="permalink"><a href="#a663ea74082d9bbe18a0c15b66b8fddaa">◆ </a></span>apreq_version_string()</h2> |
| 180 |
|
| 181 |
<div class="memitem"> |
| 182 |
<div class="memproto"> |
| 183 |
<table class="memname"> |
| 184 |
<tr> |
| 185 |
<td class="memname">const char* apreq_version_string </td> |
| 186 |
<td>(</td> |
| 187 |
<td class="paramtype">void </td> |
| 188 |
<td class="paramname"></td><td>)</td> |
| 189 |
<td></td> |
| 190 |
</tr> |
| 191 |
</table> |
| 192 |
</div><div class="memdoc"> |
| 193 |
<p>Return libapreq's version information as a string. </p> |
| 194 |
|
| 195 |
</div> |
| 196 |
</div> |
| 197 |
</div><!-- contents --> |
| 198 |
<div id="footer"> |
| 199 |
<p class="apache"> |
| 200 |
Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/> |
| 201 |
See <a href="apreq_license.html">LICENSE</a>.</p> |
| 202 |
<p class="menu"> |
| 203 |
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a> |
| 204 |
version 1.9.1 on Thu Aug 18 2022</span> |
| 205 |
</p> |
| 206 |
</div> |
| 207 |
</body> |
| 208 |
</html> |