<!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"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime: Error Codes</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Error Codes<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group___a_p_r___e_r_r_o_r__map"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___e_r_r_o_r__map.html">APR Error Space</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group___a_p_r___error"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___error.html">APR Error Values</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group___a_p_r___s_t_a_t_u_s___i_s"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___s_t_a_t_u_s___i_s.html">Status Value Tests</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga2096daff578ef301e060b80c7a4525bf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga2096daff578ef301e060b80c7a4525bf">APR_FROM_OS_ERROR</a>(e)   (e == 0 ? <a class="el" href="group__apr__errno.html#ga9ee311b7bf1c691dc521d721339ee2a6">APR_SUCCESS</a> : e + <a class="el" href="group__apr__errno.html#gad70a5cad6862a9abcc254d35e827ac8b">APR_OS_START_SYSERR</a>)</td></tr>
<tr class="separator:ga2096daff578ef301e060b80c7a4525bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2096daff578ef301e060b80c7a4525bf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga2096daff578ef301e060b80c7a4525bf">APR_FROM_OS_ERROR</a>(e)   (e)</td></tr>
<tr class="separator:ga2096daff578ef301e060b80c7a4525bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2385cae04b04afbdcb65f1a45c4d8506"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga2385cae04b04afbdcb65f1a45c4d8506">APR_TO_OS_ERROR</a>(e)   (e == 0 ? <a class="el" href="group__apr__errno.html#ga9ee311b7bf1c691dc521d721339ee2a6">APR_SUCCESS</a> : e - <a class="el" href="group__apr__errno.html#gad70a5cad6862a9abcc254d35e827ac8b">APR_OS_START_SYSERR</a>)</td></tr>
<tr class="separator:ga2385cae04b04afbdcb65f1a45c4d8506"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2385cae04b04afbdcb65f1a45c4d8506"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga2385cae04b04afbdcb65f1a45c4d8506">APR_TO_OS_ERROR</a>(e)   (e)</td></tr>
<tr class="separator:ga2385cae04b04afbdcb65f1a45c4d8506"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa76e122da00af0ce2e8c8d7ff538bdfa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gaa76e122da00af0ce2e8c8d7ff538bdfa">apr_get_os_error</a>()   (errno)</td></tr>
<tr class="separator:gaa76e122da00af0ce2e8c8d7ff538bdfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a2d9a03ad314b03a142574be6d7d8a7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga9a2d9a03ad314b03a142574be6d7d8a7">apr_set_os_error</a>(e)   (errno = (e))</td></tr>
<tr class="separator:ga9a2d9a03ad314b03a142574be6d7d8a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga66e54f155b4a80ac7df9118af9bd896a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga66e54f155b4a80ac7df9118af9bd896a">apr_get_netos_error</a>()   (errno)</td></tr>
<tr class="separator:ga66e54f155b4a80ac7df9118af9bd896a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaafc38481621653ece6f592f9c5a9a09b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gaafc38481621653ece6f592f9c5a9a09b">apr_set_netos_error</a>(e)   (errno = (e))</td></tr>
<tr class="separator:gaafc38481621653ece6f592f9c5a9a09b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga191894048b7bd0cca3cf0bdff1eb695b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga191894048b7bd0cca3cf0bdff1eb695b">APR_OS_START_ERROR</a>   20000</td></tr>
<tr class="separator:ga191894048b7bd0cca3cf0bdff1eb695b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadb8d97e6836ccdc57b43b6119a5acccf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>   50000</td></tr>
<tr class="separator:gadb8d97e6836ccdc57b43b6119a5acccf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaef5e79630739f24d1512d0d044c2bae7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gaef5e79630739f24d1512d0d044c2bae7">APR_UTIL_ERRSPACE_SIZE</a>   20000</td></tr>
<tr class="separator:gaef5e79630739f24d1512d0d044c2bae7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga450e1a5734732e092ddaa5b67414f69b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga450e1a5734732e092ddaa5b67414f69b">APR_OS_START_STATUS</a>   (<a class="el" href="group__apr__errno.html#ga191894048b7bd0cca3cf0bdff1eb695b">APR_OS_START_ERROR</a> + <a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>)</td></tr>
<tr class="separator:ga450e1a5734732e092ddaa5b67414f69b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadf26297a72afa0ea224e7097fe59a1cd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gadf26297a72afa0ea224e7097fe59a1cd">APR_UTIL_START_STATUS</a></td></tr>
<tr class="separator:gadf26297a72afa0ea224e7097fe59a1cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacd35b2de1e38a1fa4717e38d5e153571"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gacd35b2de1e38a1fa4717e38d5e153571">APR_OS_START_USERERR</a>   (<a class="el" href="group__apr__errno.html#ga450e1a5734732e092ddaa5b67414f69b">APR_OS_START_STATUS</a> + <a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>)</td></tr>
<tr class="separator:gacd35b2de1e38a1fa4717e38d5e153571"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga803b8badf8695bdfa4fbcf4d330371f0"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga803b8badf8695bdfa4fbcf4d330371f0">APR_OS_START_USEERR</a>   <a class="el" href="group__apr__errno.html#gacd35b2de1e38a1fa4717e38d5e153571">APR_OS_START_USERERR</a></td></tr>
<tr class="separator:ga803b8badf8695bdfa4fbcf4d330371f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7bca957c11b80b31cb54b0d2cbe9e025"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga7bca957c11b80b31cb54b0d2cbe9e025">APR_OS_START_CANONERR</a></td></tr>
<tr class="separator:ga7bca957c11b80b31cb54b0d2cbe9e025"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d04991cb57c67a896e22125a1f22b49"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga2d04991cb57c67a896e22125a1f22b49">APR_OS_START_EAIERR</a>   (<a class="el" href="group__apr__errno.html#ga7bca957c11b80b31cb54b0d2cbe9e025">APR_OS_START_CANONERR</a> + <a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>)</td></tr>
<tr class="separator:ga2d04991cb57c67a896e22125a1f22b49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad70a5cad6862a9abcc254d35e827ac8b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gad70a5cad6862a9abcc254d35e827ac8b">APR_OS_START_SYSERR</a>   (<a class="el" href="group__apr__errno.html#ga2d04991cb57c67a896e22125a1f22b49">APR_OS_START_EAIERR</a> + <a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>)</td></tr>
<tr class="separator:gad70a5cad6862a9abcc254d35e827ac8b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9ee311b7bf1c691dc521d721339ee2a6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#ga9ee311b7bf1c691dc521d721339ee2a6">APR_SUCCESS</a>   0</td></tr>
<tr class="separator:ga9ee311b7bf1c691dc521d721339ee2a6"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaf76ee4543247e9fb3f3546203e590a6c"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a></td></tr>
<tr class="separator:gaf76ee4543247e9fb3f3546203e590a6c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf2edf92be162ab8fb1bbc6f22856a131"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__errno.html#gaf2edf92be162ab8fb1bbc6f22856a131">apr_strerror</a> (<a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> statcode, char *buf, apr_size_t bufsize)</td></tr>
<tr class="separator:gaf2edf92be162ab8fb1bbc6f22856a131"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga2096daff578ef301e060b80c7a4525bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2096daff578ef301e060b80c7a4525bf">◆ </a></span>APR_FROM_OS_ERROR <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FROM_OS_ERROR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">e</td><td>)</td>
<td>   (e == 0 ? <a class="el" href="group__apr__errno.html#ga9ee311b7bf1c691dc521d721339ee2a6">APR_SUCCESS</a> : e + <a class="el" href="group__apr__errno.html#gad70a5cad6862a9abcc254d35e827ac8b">APR_OS_START_SYSERR</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fold a platform specific error into an apr_status_t code. </p><dl class="section return"><dt>Returns</dt><dd>apr_status_t </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The platform os error code. </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>macro implementation; the syserr argument may be evaluated multiple times. </dd></dl>
</div>
</div>
<a id="ga2096daff578ef301e060b80c7a4525bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2096daff578ef301e060b80c7a4525bf">◆ </a></span>APR_FROM_OS_ERROR <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_FROM_OS_ERROR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">e</td><td>)</td>
<td>   (e)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fold a platform specific error into an apr_status_t code. </p><dl class="section return"><dt>Returns</dt><dd>apr_status_t </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The platform os error code. </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>macro implementation; the syserr argument may be evaluated multiple times. </dd></dl>
</div>
</div>
<a id="ga66e54f155b4a80ac7df9118af9bd896a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga66e54f155b4a80ac7df9118af9bd896a">◆ </a></span>apr_get_netos_error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define apr_get_netos_error</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (errno)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the last socket error, folded into apr_status_t, on all platforms </p><dl class="section remark"><dt>Remarks</dt><dd>This retrieves errno or calls a GetLastSocketError() style function, and folds it with APR_FROM_OS_ERROR. </dd></dl>
</div>
</div>
<a id="gaa76e122da00af0ce2e8c8d7ff538bdfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa76e122da00af0ce2e8c8d7ff538bdfa">◆ </a></span>apr_get_os_error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define apr_get_os_error</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (errno)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>apr_status_t the last platform error, folded into apr_status_t, on most platforms </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>This retrieves errno, or calls a GetLastError() style function, and folds it with APR_FROM_OS_ERROR. Some platforms (such as OS2) have no such mechanism, so this call may be unsupported. Do NOT use this call for socket errors from socket, send, recv etc! </dd></dl>
</div>
</div>
<a id="gadb8d97e6836ccdc57b43b6119a5acccf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadb8d97e6836ccdc57b43b6119a5acccf">◆ </a></span>APR_OS_ERRSPACE_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OS_ERRSPACE_SIZE   50000</td>
</tr>
</table>
</div><div class="memdoc">
<p>APR_OS_ERRSPACE_SIZE is the maximum number of errors you can fit into one of the error/status ranges below – except for APR_OS_START_USERERR, which see. </p>
</div>
</div>
<a id="ga7bca957c11b80b31cb54b0d2cbe9e025"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7bca957c11b80b31cb54b0d2cbe9e025">◆ </a></span>APR_OS_START_CANONERR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OS_START_CANONERR</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">(<a class="code" href="group__apr__errno.html#gacd35b2de1e38a1fa4717e38d5e153571">APR_OS_START_USERERR</a> \</div><div class="line"> + (<a class="code" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a> * 10))</div><div class="ttc" id="group__apr__errno_html_gacd35b2de1e38a1fa4717e38d5e153571"><div class="ttname"><a href="group__apr__errno.html#gacd35b2de1e38a1fa4717e38d5e153571">APR_OS_START_USERERR</a></div><div class="ttdeci">#define APR_OS_START_USERERR</div><div class="ttdef"><b>Definition:</b> apr_errno.h:164</div></div>
<div class="ttc" id="group__apr__errno_html_gadb8d97e6836ccdc57b43b6119a5acccf"><div class="ttname"><a href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a></div><div class="ttdeci">#define APR_OS_ERRSPACE_SIZE</div><div class="ttdef"><b>Definition:</b> apr_errno.h:123</div></div>
</div><!-- fragment --><p>APR_OS_START_CANONERR is where APR versions of errno values are defined on systems which don't have the corresponding errno. </p>
</div>
</div>
<a id="ga2d04991cb57c67a896e22125a1f22b49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2d04991cb57c67a896e22125a1f22b49">◆ </a></span>APR_OS_START_EAIERR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OS_START_EAIERR   (<a class="el" href="group__apr__errno.html#ga7bca957c11b80b31cb54b0d2cbe9e025">APR_OS_START_CANONERR</a> + <a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>APR_OS_START_EAIERR folds EAI_ error codes from getaddrinfo() into apr_status_t values. </p>
</div>
</div>
<a id="ga191894048b7bd0cca3cf0bdff1eb695b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga191894048b7bd0cca3cf0bdff1eb695b">◆ </a></span>APR_OS_START_ERROR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OS_START_ERROR   20000</td>
</tr>
</table>
</div><div class="memdoc">
<p>APR_OS_START_ERROR is where the APR specific error values start. </p>
</div>
</div>
<a id="ga450e1a5734732e092ddaa5b67414f69b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga450e1a5734732e092ddaa5b67414f69b">◆ </a></span>APR_OS_START_STATUS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OS_START_STATUS   (<a class="el" href="group__apr__errno.html#ga191894048b7bd0cca3cf0bdff1eb695b">APR_OS_START_ERROR</a> + <a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>APR_OS_START_STATUS is where the APR specific status codes start. </p>
</div>
</div>
<a id="gad70a5cad6862a9abcc254d35e827ac8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad70a5cad6862a9abcc254d35e827ac8b">◆ </a></span>APR_OS_START_SYSERR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OS_START_SYSERR   (<a class="el" href="group__apr__errno.html#ga2d04991cb57c67a896e22125a1f22b49">APR_OS_START_EAIERR</a> + <a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>APR_OS_START_SYSERR folds platform-specific system error values into apr_status_t values. </p>
</div>
</div>
<a id="ga803b8badf8695bdfa4fbcf4d330371f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga803b8badf8695bdfa4fbcf4d330371f0">◆ </a></span>APR_OS_START_USEERR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OS_START_USEERR   <a class="el" href="group__apr__errno.html#gacd35b2de1e38a1fa4717e38d5e153571">APR_OS_START_USERERR</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>APR_OS_START_USEERR is obsolete, defined for compatibility only. Use APR_OS_START_USERERR instead. </p>
</div>
</div>
<a id="gacd35b2de1e38a1fa4717e38d5e153571"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd35b2de1e38a1fa4717e38d5e153571">◆ </a></span>APR_OS_START_USERERR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_OS_START_USERERR   (<a class="el" href="group__apr__errno.html#ga450e1a5734732e092ddaa5b67414f69b">APR_OS_START_STATUS</a> + <a class="el" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>APR_OS_START_USERERR are reserved for applications that use APR that layer their own error codes along with APR's. Note that the error immediately following this one is set ten times farther away than usual, so that users of apr have a lot of room in which to declare custom error codes.</p>
<p>In general applications should try and create unique error codes. To try and assist in finding suitable ranges of numbers to use, the following ranges are known to be used by the listed applications. If your application defines error codes please advise the range of numbers it uses to <a href="#" onclick="location.href='mai'+'lto:'+'dev'+'@a'+'pr.'+'ap'+'ach'+'e.'+'org'; return false;">dev@a<span style="display: none;">.nosp@m.</span>pr.a<span style="display: none;">.nosp@m.</span>pache<span style="display: none;">.nosp@m.</span>.org</a> for inclusion in this list.</p>
<p>Ranges shown are in relation to APR_OS_START_USERERR</p>
<p>Subversion - Defined ranges, of less than 100, at intervals of 5000 starting at an offset of 5000, e.g. +5000 to 5100, +10000 to 10100</p>
<p>Apache HTTPD - +2000 to 2999 </p>
</div>
</div>
<a id="gaafc38481621653ece6f592f9c5a9a09b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaafc38481621653ece6f592f9c5a9a09b">◆ </a></span>apr_set_netos_error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define apr_set_netos_error</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">e</td><td>)</td>
<td>   (errno = (e))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the last socket error, unfolded from an apr_status_t </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The socket error folded in a prior call to <a class="el" href="group__apr__errno.html#ga2096daff578ef301e060b80c7a4525bf">APR_FROM_OS_ERROR()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>This is a macro implementation; the statcode argument may be evaluated multiple times. If the statcode was not created by apr_get_os_error or APR_FROM_OS_ERROR, the results are undefined. This macro sets errno, or calls a WSASetLastError() style function, unfolding socketcode with APR_TO_OS_ERROR. </dd></dl>
</div>
</div>
<a id="ga9a2d9a03ad314b03a142574be6d7d8a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a2d9a03ad314b03a142574be6d7d8a7">◆ </a></span>apr_set_os_error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define apr_set_os_error</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">e</td><td>)</td>
<td>   (errno = (e))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the last platform error, unfolded from an apr_status_t, on some platforms </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The OS error folded in a prior call to <a class="el" href="group__apr__errno.html#ga2096daff578ef301e060b80c7a4525bf">APR_FROM_OS_ERROR()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>This is a macro implementation; the statcode argument may be evaluated multiple times. If the statcode was not created by apr_get_os_error or APR_FROM_OS_ERROR, the results are undefined. This macro sets errno, or calls a SetLastError() style function, unfolding statcode with APR_TO_OS_ERROR. Some platforms (such as OS2) have no such mechanism, so this call may be unsupported. </dd></dl>
</div>
</div>
<a id="ga9ee311b7bf1c691dc521d721339ee2a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ee311b7bf1c691dc521d721339ee2a6">◆ </a></span>APR_SUCCESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_SUCCESS   0</td>
</tr>
</table>
</div><div class="memdoc">
<p>no error. </p>
</div>
</div>
<a id="ga2385cae04b04afbdcb65f1a45c4d8506"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2385cae04b04afbdcb65f1a45c4d8506">◆ </a></span>APR_TO_OS_ERROR <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_TO_OS_ERROR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">e</td><td>)</td>
<td>   (e == 0 ? <a class="el" href="group__apr__errno.html#ga9ee311b7bf1c691dc521d721339ee2a6">APR_SUCCESS</a> : e - <a class="el" href="group__apr__errno.html#gad70a5cad6862a9abcc254d35e827ac8b">APR_OS_START_SYSERR</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>os_err_type Fold an apr_status_t code back to the native platform defined error. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The apr_status_t folded platform os error code. </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>macro implementation; the statcode argument may be evaluated multiple times. If the statcode was not created by apr_get_os_error or APR_FROM_OS_ERROR, the results are undefined. </dd></dl>
</div>
</div>
<a id="ga2385cae04b04afbdcb65f1a45c4d8506"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2385cae04b04afbdcb65f1a45c4d8506">◆ </a></span>APR_TO_OS_ERROR <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_TO_OS_ERROR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">e</td><td>)</td>
<td>   (e)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>os_err_type Fold an apr_status_t code back to the native platform defined error. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">e</td><td>The apr_status_t folded platform os error code. </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>macro implementation; the statcode argument may be evaluated multiple times. If the statcode was not created by apr_get_os_error or APR_FROM_OS_ERROR, the results are undefined. </dd></dl>
</div>
</div>
<a id="gaef5e79630739f24d1512d0d044c2bae7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaef5e79630739f24d1512d0d044c2bae7">◆ </a></span>APR_UTIL_ERRSPACE_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_UTIL_ERRSPACE_SIZE   20000</td>
</tr>
</table>
</div><div class="memdoc">
<p>APR_UTIL_ERRSPACE_SIZE is the size of the space that is reserved for use within apr-util. This space is reserved above that used by APR internally. </p><dl class="section note"><dt>Note</dt><dd>This number MUST be smaller than APR_OS_ERRSPACE_SIZE by a large enough amount that APR has sufficient room for its codes. </dd></dl>
</div>
</div>
<a id="gadf26297a72afa0ea224e7097fe59a1cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadf26297a72afa0ea224e7097fe59a1cd">◆ </a></span>APR_UTIL_START_STATUS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_UTIL_START_STATUS</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">(<a class="code" href="group__apr__errno.html#ga450e1a5734732e092ddaa5b67414f69b">APR_OS_START_STATUS</a> + \</div><div class="line"> (<a class="code" href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a> - <a class="code" href="group__apr__errno.html#gaef5e79630739f24d1512d0d044c2bae7">APR_UTIL_ERRSPACE_SIZE</a>))</div><div class="ttc" id="group__apr__errno_html_ga450e1a5734732e092ddaa5b67414f69b"><div class="ttname"><a href="group__apr__errno.html#ga450e1a5734732e092ddaa5b67414f69b">APR_OS_START_STATUS</a></div><div class="ttdeci">#define APR_OS_START_STATUS</div><div class="ttdef"><b>Definition:</b> apr_errno.h:136</div></div>
<div class="ttc" id="group__apr__errno_html_gaef5e79630739f24d1512d0d044c2bae7"><div class="ttname"><a href="group__apr__errno.html#gaef5e79630739f24d1512d0d044c2bae7">APR_UTIL_ERRSPACE_SIZE</a></div><div class="ttdeci">#define APR_UTIL_ERRSPACE_SIZE</div><div class="ttdef"><b>Definition:</b> apr_errno.h:132</div></div>
<div class="ttc" id="group__apr__errno_html_gadb8d97e6836ccdc57b43b6119a5acccf"><div class="ttname"><a href="group__apr__errno.html#gadb8d97e6836ccdc57b43b6119a5acccf">APR_OS_ERRSPACE_SIZE</a></div><div class="ttdeci">#define APR_OS_ERRSPACE_SIZE</div><div class="ttdef"><b>Definition:</b> apr_errno.h:123</div></div>
</div><!-- fragment --><p>APR_UTIL_START_STATUS is where APR-Util starts defining its status codes. </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gaf76ee4543247e9fb3f3546203e590a6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf76ee4543247e9fb3f3546203e590a6c">◆ </a></span>apr_status_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int <a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for specifying an error or status code. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf2edf92be162ab8fb1bbc6f22856a131"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf2edf92be162ab8fb1bbc6f22856a131">◆ </a></span>apr_strerror()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* apr_strerror </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td>
<td class="paramname"><em>statcode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t </td>
<td class="paramname"><em>bufsize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a human readable string describing the specified error. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">statcode</td><td>The error code to get a string for. </td></tr>
<tr><td class="paramname">buf</td><td>A buffer to hold the error string. </td></tr>
<tr><td class="paramname">bufsize</td><td>Size of the buffer to hold the string. </td></tr>
</table>
</dd>
</dl>
</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.13
</small></address>
</body>
</html>
