<!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: Memory Pool Functions</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">Memory Pool Functions<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___pool_cleanup"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_cleanup.html">Pool Cleanup Functions</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group___pool_debug"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_debug.html">Pool Debugging functions.</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:ga89ce1d55c7f0c39ea87c88eabd655394"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga89ce1d55c7f0c39ea87c88eabd655394">APR_POOL_DECLARE_ACCESSOR</a>(type)</td></tr>
<tr class="separator:ga89ce1d55c7f0c39ea87c88eabd655394"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga43a8a52f68f8b7d3b7694c254da4a074"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga43a8a52f68f8b7d3b7694c254da4a074">APR_POOL_IMPLEMENT_ACCESSOR</a>(type)</td></tr>
<tr class="separator:ga43a8a52f68f8b7d3b7694c254da4a074"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac81cff34d0ff4be52fa924663478eade"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gac81cff34d0ff4be52fa924663478eade">APR_POOL__FILE_LINE__</a>   __FILE__ ":" <a class="el" href="apr__version_8h.html#ae90215615972dfa4108018304361ef0b">APR_STRINGIFY</a>(__LINE__)</td></tr>
<tr class="separator:gac81cff34d0ff4be52fa924663478eade"><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:gaf137f28edcf9a086cd6bc36c20d7cdfb"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a></td></tr>
<tr class="separator:gaf137f28edcf9a086cd6bc36c20d7cdfb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga370a939349adf6d1438068e2fc69a0dd"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a>) (int retcode)</td></tr>
<tr class="separator:ga370a939349adf6d1438068e2fc69a0dd"><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:gad64a6a29515621bc13f8a8da50366d67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gad64a6a29515621bc13f8a8da50366d67">apr_pool_initialize</a> (void)</td></tr>
<tr class="separator:gad64a6a29515621bc13f8a8da50366d67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3728aacec227318cef973b8a33f3b430"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga3728aacec227318cef973b8a33f3b430">apr_pool_terminate</a> (void)</td></tr>
<tr class="separator:ga3728aacec227318cef973b8a33f3b430"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab274bd29e4e4d4944b4618403148074f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gab274bd29e4e4d4944b4618403148074f">apr_pool_create_ex</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *parent, <a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator)</td></tr>
<tr class="separator:gab274bd29e4e4d4944b4618403148074f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga20e514c83555398acddc30c4dfa0c540"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga20e514c83555398acddc30c4dfa0c540">apr_pool_create_core_ex</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator)</td></tr>
<tr class="separator:ga20e514c83555398acddc30c4dfa0c540"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaae7212db77bb57f86419cd594f73a92f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaae7212db77bb57f86419cd594f73a92f">apr_pool_create_unmanaged_ex</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator)</td></tr>
<tr class="separator:gaae7212db77bb57f86419cd594f73a92f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gacbea97ae5c0c861f6b7c147d46ac1d0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gacbea97ae5c0c861f6b7c147d46ac1d0c">apr_pool_create_ex_debug</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *parent, <a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator, const char *file_line)</td></tr>
<tr class="separator:gacbea97ae5c0c861f6b7c147d46ac1d0c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1c5bfc44188884bb439670f81448c20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaa1c5bfc44188884bb439670f81448c20">apr_pool_create_core_ex_debug</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator, const char *file_line)</td></tr>
<tr class="separator:gaa1c5bfc44188884bb439670f81448c20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae220e572b14355f1aa7b21c8fb022524"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gae220e572b14355f1aa7b21c8fb022524">apr_pool_create_unmanaged_ex_debug</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> *allocator, const char *file_line)</td></tr>
<tr class="separator:gae220e572b14355f1aa7b21c8fb022524"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga918adf3026c894efeae254a0446aed3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga918adf3026c894efeae254a0446aed3b">apr_pool_create</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *parent)</td></tr>
<tr class="separator:ga918adf3026c894efeae254a0446aed3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad3675378924bc9d98e46258c049f1761"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gad3675378924bc9d98e46258c049f1761">apr_pool_create_core</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool)</td></tr>
<tr class="separator:gad3675378924bc9d98e46258c049f1761"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga72f86d699b4b2ec2aeb82c334ca3446b"><td class="memItemLeft" align="right" valign="top"><a id="ga72f86d699b4b2ec2aeb82c334ca3446b"></a>
<a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><b>apr_pool_create_unmanaged</b> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> **newpool)</td></tr>
<tr class="separator:ga72f86d699b4b2ec2aeb82c334ca3446b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf446fcf5da1fcd62d3f802a4c0c10f97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaf446fcf5da1fcd62d3f802a4c0c10f97">apr_pool_allocator_get</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr class="separator:gaf446fcf5da1fcd62d3f802a4c0c10f97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafa8a998cd660e82b62aecec09e239d0d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gafa8a998cd660e82b62aecec09e239d0d">apr_pool_clear</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:gafa8a998cd660e82b62aecec09e239d0d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9521870e42ec4395a0bf8388706a57b9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga9521870e42ec4395a0bf8388706a57b9">apr_pool_clear_debug</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *file_line)</td></tr>
<tr class="separator:ga9521870e42ec4395a0bf8388706a57b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga54759954d2cba7cb649ab5680a33f9e3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga54759954d2cba7cb649ab5680a33f9e3">apr_pool_destroy</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p)</td></tr>
<tr class="separator:ga54759954d2cba7cb649ab5680a33f9e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7efe64dfcce883d7fad9df813d9259fc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga7efe64dfcce883d7fad9df813d9259fc">apr_pool_destroy_debug</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const char *file_line)</td></tr>
<tr class="separator:ga7efe64dfcce883d7fad9df813d9259fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga85f1e193c31d109affda72f9a92c6915"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga85f1e193c31d109affda72f9a92c6915">apr_palloc</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_size_t size)</td></tr>
<tr class="separator:ga85f1e193c31d109affda72f9a92c6915"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0ac211ac89be868b107776b4183a8174"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga0ac211ac89be868b107776b4183a8174">apr_palloc_debug</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_size_t size, const char *file_line)</td></tr>
<tr class="separator:ga0ac211ac89be868b107776b4183a8174"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf61c098ad258069d64cdf8c0a9369f9e"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaf61c098ad258069d64cdf8c0a9369f9e">apr_pcalloc</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_size_t size)</td></tr>
<tr class="separator:gaf61c098ad258069d64cdf8c0a9369f9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7b43035318ffdc57a6eddab07dc57cb2"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga7b43035318ffdc57a6eddab07dc57cb2">apr_pcalloc_debug</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_size_t size, const char *file_line)</td></tr>
<tr class="separator:ga7b43035318ffdc57a6eddab07dc57cb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa658b1f10dd13967eaa7c4156d4c2174"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaa658b1f10dd13967eaa7c4156d4c2174">apr_pool_abort_set</a> (<a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> abortfunc, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr class="separator:gaa658b1f10dd13967eaa7c4156d4c2174"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf7610c30ef5f84a8742c0b3e63fdd7b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaf7610c30ef5f84a8742c0b3e63fdd7b0">apr_pool_abort_get</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr class="separator:gaf7610c30ef5f84a8742c0b3e63fdd7b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga94db31f40609b15b592ff47f989ca9ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga94db31f40609b15b592ff47f989ca9ec">apr_pool_parent_get</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr class="separator:ga94db31f40609b15b592ff47f989ca9ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga05d299f778659d1e0806140d8a7fea79"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga05d299f778659d1e0806140d8a7fea79">apr_pool_is_ancestor</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *a, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *b)</td></tr>
<tr class="separator:ga05d299f778659d1e0806140d8a7fea79"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaeaa872f7999740a60803e95429890518"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaeaa872f7999740a60803e95429890518">apr_pool_tag</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, const char *tag)</td></tr>
<tr class="separator:gaeaa872f7999740a60803e95429890518"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga78d1aa2d9fa842d83eaffccb0f0c0c5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga78d1aa2d9fa842d83eaffccb0f0c0c5c">apr_pool_userdata_set</a> (const void *data, const char *key, <a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>(*cleanup)(void *), <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr class="separator:ga78d1aa2d9fa842d83eaffccb0f0c0c5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga435644c493dc5b10d80c4b99b8cd4589"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga435644c493dc5b10d80c4b99b8cd4589">apr_pool_userdata_setn</a> (const void *data, const char *key, <a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>(*cleanup)(void *), <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr class="separator:ga435644c493dc5b10d80c4b99b8cd4589"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf930f1fad2cf92a2432c0814c8a0b86f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gaf930f1fad2cf92a2432c0814c8a0b86f">apr_pool_userdata_get</a> (void **data, const char *key, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr class="separator:gaf930f1fad2cf92a2432c0814c8a0b86f"><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="gac81cff34d0ff4be52fa924663478eade"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac81cff34d0ff4be52fa924663478eade">◆ </a></span>APR_POOL__FILE_LINE__</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POOL__FILE_LINE__   __FILE__ ":" <a class="el" href="apr__version_8h.html#ae90215615972dfa4108018304361ef0b">APR_STRINGIFY</a>(__LINE__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Pool debug levels</p>
<pre>
<h2>| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
</h2>
</pre><pre>
| | | | | | | | x | General debug code enabled (useful in
combination with –with-efence).</pre><pre>| | | | | | | x | | Verbose output on stderr (report
CREATE, CLEAR, DESTROY).</pre><pre>| | | | x | | | | | Verbose output on stderr (report
PALLOC, PCALLOC).</pre><pre>| | | | | | x | | | Lifetime checking. On each use of a
pool, check its lifetime. If the pool
is out of scope, abort().
In combination with the verbose flag
above, it will output LIFE in such an
event prior to aborting.</pre><pre>| | | | | x | | | | Pool owner checking. On each use of a
pool, check if the current thread is the
pool's owner. If not, abort(). In
combination with the verbose flag above,
it will output OWNER in such an event
prior to aborting. Use the debug
function apr_pool_owner_set() to switch
a pool's ownership.</pre><pre>When no debug level was specified, assume general debug mode.
If level 0 was specified, debugging is switched off.
</pre><p>the place in the code where the particular function was called </p>
</div>
</div>
<a id="ga89ce1d55c7f0c39ea87c88eabd655394"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga89ce1d55c7f0c39ea87c88eabd655394">◆ </a></span>APR_POOL_DECLARE_ACCESSOR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POOL_DECLARE_ACCESSOR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">type</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__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *) apr_##type##_pool_get \</div><div class="line"> (<span class="keyword">const</span> apr_##type##_t *the##type)</div><div class="ttc" id="group__apr__platform_html_gad7b91b811a172bfa802603c2fb688f98"><div class="ttname"><a href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a></div><div class="ttdeci">#define APR_DECLARE(type)</div><div class="ttdef"><b>Definition:</b> apr.h:479</div></div>
<div class="ttc" id="group__apr__pools_html_gaf137f28edcf9a086cd6bc36c20d7cdfb"><div class="ttname"><a href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a></div><div class="ttdeci">struct apr_pool_t apr_pool_t</div><div class="ttdef"><b>Definition:</b> apr_pools.h:60</div></div>
</div><!-- fragment --><p>Declaration helper macro to construct apr_foo_pool_get()s.</p>
<p>This standardized macro is used by opaque (APR) data types to return the apr_pool_t that is associated with the data type.</p>
<p><a class="el" href="group__apr__pools.html#ga89ce1d55c7f0c39ea87c88eabd655394">APR_POOL_DECLARE_ACCESSOR()</a> is used in a header file to declare the accessor function. A typical usage and result would be: </p><pre>
<a class="el" href="group__apr__pools.html#ga89ce1d55c7f0c39ea87c88eabd655394">APR_POOL_DECLARE_ACCESSOR(file)</a>;
becomes:
<a class="el" href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE(apr_pool_t *)</a> <a class="el" href="group__apr__file__io.html#gab5950b3b0156097b0181394a37e03ede">apr_file_pool_get(const apr_file_t *thefile)</a>;
</pre> <dl class="section remark"><dt>Remarks</dt><dd>Doxygen unwraps this macro (via doxygen.conf) to provide actual help for each specific occurrence of apr_foo_pool_get. </dd>
<dd>
the linkage is specified for APR. It would be possible to expand the macros to support other linkages. </dd></dl>
</div>
</div>
<a id="ga43a8a52f68f8b7d3b7694c254da4a074"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga43a8a52f68f8b7d3b7694c254da4a074">◆ </a></span>APR_POOL_IMPLEMENT_ACCESSOR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POOL_IMPLEMENT_ACCESSOR</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">type</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__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *) apr_##type##_pool_get \</div><div class="line"> (<span class="keyword">const</span> apr_##type##_t *the##type) \</div><div class="line"> { <span class="keywordflow">return</span> the##type->pool; }</div><div class="ttc" id="group__apr__platform_html_gad7b91b811a172bfa802603c2fb688f98"><div class="ttname"><a href="group__apr__platform.html#gad7b91b811a172bfa802603c2fb688f98">APR_DECLARE</a></div><div class="ttdeci">#define APR_DECLARE(type)</div><div class="ttdef"><b>Definition:</b> apr.h:479</div></div>
<div class="ttc" id="group__apr__pools_html_gaf137f28edcf9a086cd6bc36c20d7cdfb"><div class="ttname"><a href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a></div><div class="ttdeci">struct apr_pool_t apr_pool_t</div><div class="ttdef"><b>Definition:</b> apr_pools.h:60</div></div>
</div><!-- fragment --><p>Implementation helper macro to provide apr_foo_pool_get()s.</p>
<p>In the implementation, the <a class="el" href="group__apr__pools.html#ga43a8a52f68f8b7d3b7694c254da4a074">APR_POOL_IMPLEMENT_ACCESSOR()</a> is used to actually define the function. It assumes the field is named "pool". </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga370a939349adf6d1438068e2fc69a0dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga370a939349adf6d1438068e2fc69a0dd">◆ </a></span>apr_abortfunc_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* apr_abortfunc_t) (int retcode)</td>
</tr>
</table>
</div><div class="memdoc">
<p>A function that is called when allocation fails. </p>
</div>
</div>
<a id="gaf137f28edcf9a086cd6bc36c20d7cdfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf137f28edcf9a086cd6bc36c20d7cdfb">◆ </a></span>apr_pool_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The fundamental pool type </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga85f1e193c31d109affda72f9a92c6915"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85f1e193c31d109affda72f9a92c6915">◆ </a></span>apr_palloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* apr_palloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a block of memory from a pool </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pool to allocate from </td></tr>
<tr><td class="paramname">size</td><td>The amount of memory to allocate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The allocated memory </dd></dl>
</div>
</div>
<a id="ga0ac211ac89be868b107776b4183a8174"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ac211ac89be868b107776b4183a8174">◆ </a></span>apr_palloc_debug()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* apr_palloc_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file_line</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug version of apr_palloc </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>See: apr_palloc </td></tr>
<tr><td class="paramname">size</td><td>See: apr_palloc </td></tr>
<tr><td class="paramname">file_line</td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See: apr_palloc </dd></dl>
</div>
</div>
<a id="gaf61c098ad258069d64cdf8c0a9369f9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf61c098ad258069d64cdf8c0a9369f9e">◆ </a></span>apr_pcalloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* apr_pcalloc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a block of memory from a pool and set all of the memory to 0 </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pool to allocate from </td></tr>
<tr><td class="paramname">size</td><td>The amount of memory to allocate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The allocated memory </dd></dl>
</div>
</div>
<a id="ga7b43035318ffdc57a6eddab07dc57cb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7b43035318ffdc57a6eddab07dc57cb2">◆ </a></span>apr_pcalloc_debug()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* apr_pcalloc_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file_line</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug version of apr_pcalloc </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>See: apr_pcalloc </td></tr>
<tr><td class="paramname">size</td><td>See: apr_pcalloc </td></tr>
<tr><td class="paramname">file_line</td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See: apr_pcalloc </dd></dl>
</div>
</div>
<a id="gaf7610c30ef5f84a8742c0b3e63fdd7b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf7610c30ef5f84a8742c0b3e63fdd7b0">◆ </a></span>apr_pool_abort_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> apr_pool_abort_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the abort function associated with the specified pool. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pool</td><td>The pool for retrieving the abort function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The abort function for the given pool. </dd></dl>
</div>
</div>
<a id="gaa658b1f10dd13967eaa7c4156d4c2174"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa658b1f10dd13967eaa7c4156d4c2174">◆ </a></span>apr_pool_abort_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_pool_abort_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> </td>
<td class="paramname"><em>abortfunc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the function to be called when an allocation failure occurs. </p><dl class="section remark"><dt>Remarks</dt><dd>If the program wants APR to exit on a memory allocation error, then this function can be called to set the callback to use (for performing cleanup and then exiting). If this function is not called, then APR will return an error and expect the calling program to deal with the error accordingly. </dd></dl>
</div>
</div>
<a id="gaf446fcf5da1fcd62d3f802a4c0c10f97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf446fcf5da1fcd62d3f802a4c0c10f97">◆ </a></span>apr_pool_allocator_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a>* apr_pool_allocator_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the pool's allocator </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pool</td><td>The pool to get the allocator from. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gafa8a998cd660e82b62aecec09e239d0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafa8a998cd660e82b62aecec09e239d0d">◆ </a></span>apr_pool_clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_pool_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear all memory in the pool and run all the cleanups. This also destroys all subpools. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pool to clear </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>This does not actually free the memory, it just allows the pool to re-use this memory for the next allocation. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__apr__pools.html#ga54759954d2cba7cb649ab5680a33f9e3">apr_pool_destroy()</a> </dd></dl>
</div>
</div>
<a id="ga9521870e42ec4395a0bf8388706a57b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9521870e42ec4395a0bf8388706a57b9">◆ </a></span>apr_pool_clear_debug()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_pool_clear_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file_line</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug version of apr_pool_clear. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>See: apr_pool_clear. </td></tr>
<tr><td class="paramname">file_line</td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Only available when APR_POOL_DEBUG is defined. Call this directly if you have your apr_pool_clear calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_clear in a wrapper, trust the macro and don't call apr_pool_destroy_clear directly. </dd></dl>
</div>
</div>
<a id="ga918adf3026c894efeae254a0446aed3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga918adf3026c894efeae254a0446aed3b">◆ </a></span>apr_pool_create()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> ** </td>
<td class="paramname"><em>newpool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>parent</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new pool. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newpool</td><td>The pool we have just created. </td></tr>
<tr><td class="paramname">parent</td><td>The parent pool. If this is NULL, the new pool is a root pool. If it is non-NULL, the new pool will inherit all of its parent pool's attributes, except the apr_pool_t will be a sub-pool. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>This function is thread-safe, in the sense that multiple threads can safely create subpools of the same parent pool concurrently. Similarly, a subpool can be created by one thread at the same time that another thread accesses the parent pool. </dd></dl>
</div>
</div>
<a id="gad3675378924bc9d98e46258c049f1761"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad3675378924bc9d98e46258c049f1761">◆ </a></span>apr_pool_create_core()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_create_core </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> ** </td>
<td class="paramname"><em>newpool</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new unmanaged pool. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newpool</td><td>The pool we have just created. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga20e514c83555398acddc30c4dfa0c540"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga20e514c83555398acddc30c4dfa0c540">◆ </a></span>apr_pool_create_core_ex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_create_core_ex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> ** </td>
<td class="paramname"><em>newpool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> </td>
<td class="paramname"><em>abort_fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> * </td>
<td class="paramname"><em>allocator</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new pool. </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000033">Deprecated:</a></b></dt><dd></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__apr__pools.html#gaae7212db77bb57f86419cd594f73a92f">apr_pool_create_unmanaged_ex</a>. </dd></dl>
</div>
</div>
<a id="gaa1c5bfc44188884bb439670f81448c20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1c5bfc44188884bb439670f81448c20">◆ </a></span>apr_pool_create_core_ex_debug()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_create_core_ex_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> ** </td>
<td class="paramname"><em>newpool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> </td>
<td class="paramname"><em>abort_fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> * </td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file_line</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug version of apr_pool_create_core_ex. </p><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000034">Deprecated:</a></b></dt><dd></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__apr__pools.html#gae220e572b14355f1aa7b21c8fb022524">apr_pool_create_unmanaged_ex_debug</a>. </dd></dl>
</div>
</div>
<a id="gab274bd29e4e4d4944b4618403148074f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab274bd29e4e4d4944b4618403148074f">◆ </a></span>apr_pool_create_ex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_create_ex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> ** </td>
<td class="paramname"><em>newpool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> </td>
<td class="paramname"><em>abort_fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> * </td>
<td class="paramname"><em>allocator</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new pool. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newpool</td><td>The pool we have just created. </td></tr>
<tr><td class="paramname">parent</td><td>The parent pool. If this is NULL, the new pool is a root pool. If it is non-NULL, the new pool will inherit all of its parent pool's attributes, except the apr_pool_t will be a sub-pool. </td></tr>
<tr><td class="paramname">abort_fn</td><td>A function to use if the pool cannot allocate more memory. </td></tr>
<tr><td class="paramname">allocator</td><td>The allocator to use with the new pool. If NULL the allocator of the parent pool will be used. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>This function is thread-safe, in the sense that multiple threads can safely create subpools of the same parent pool concurrently. Similarly, a subpool can be created by one thread at the same time that another thread accesses the parent pool. </dd></dl>
</div>
</div>
<a id="gacbea97ae5c0c861f6b7c147d46ac1d0c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacbea97ae5c0c861f6b7c147d46ac1d0c">◆ </a></span>apr_pool_create_ex_debug()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_create_ex_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> ** </td>
<td class="paramname"><em>newpool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> </td>
<td class="paramname"><em>abort_fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> * </td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file_line</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug version of apr_pool_create_ex. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newpool</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__apr__pools.html#ga918adf3026c894efeae254a0446aed3b">apr_pool_create</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parent</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__apr__pools.html#ga918adf3026c894efeae254a0446aed3b">apr_pool_create</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">abort_fn</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__apr__pools.html#ga918adf3026c894efeae254a0446aed3b">apr_pool_create</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">allocator</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__apr__pools.html#ga918adf3026c894efeae254a0446aed3b">apr_pool_create</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_line</td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Only available when APR_POOL_DEBUG is defined. Call this directly if you have your apr_pool_create_ex calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_create_ex in a wrapper, trust the macro and don't call apr_pool_create_ex_debug directly. </dd></dl>
</div>
</div>
<a id="gaae7212db77bb57f86419cd594f73a92f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae7212db77bb57f86419cd594f73a92f">◆ </a></span>apr_pool_create_unmanaged_ex()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_create_unmanaged_ex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> ** </td>
<td class="paramname"><em>newpool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> </td>
<td class="paramname"><em>abort_fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> * </td>
<td class="paramname"><em>allocator</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new unmanaged pool. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newpool</td><td>The pool we have just created. </td></tr>
<tr><td class="paramname">abort_fn</td><td>A function to use if the pool cannot allocate more memory. </td></tr>
<tr><td class="paramname">allocator</td><td>The allocator to use with the new pool. If NULL a new allocator will be created with the new pool as owner. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>An unmanaged pool is a special pool without a parent; it will NOT be destroyed upon apr_terminate. It must be explicitly destroyed by calling apr_pool_destroy, to prevent memory leaks. Use of this function is discouraged, think twice about whether you really really need it. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Any child cleanups registered against the new pool, or against sub-pools thereof, will not be executed during an invocation of <a class="el" href="group__apr__thread__proc.html#gab51dd90b98d365a969f0ec5c7bef4e14">apr_proc_create()</a>, so resources created in an "unmanaged" pool hierarchy will leak to child processes. </dd></dl>
</div>
</div>
<a id="gae220e572b14355f1aa7b21c8fb022524"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae220e572b14355f1aa7b21c8fb022524">◆ </a></span>apr_pool_create_unmanaged_ex_debug()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_create_unmanaged_ex_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> ** </td>
<td class="paramname"><em>newpool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#ga370a939349adf6d1438068e2fc69a0dd">apr_abortfunc_t</a> </td>
<td class="paramname"><em>abort_fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__allocator.html#ga1ceabfd30fcfc455e47d052d2a24244b">apr_allocator_t</a> * </td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file_line</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug version of apr_pool_create_unmanaged_ex. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newpool</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>apr_pool_create_unmanaged. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">abort_fn</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>apr_pool_create_unmanaged. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">allocator</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>apr_pool_create_unmanaged. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_line</td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Only available when APR_POOL_DEBUG is defined. Call this directly if you have your apr_pool_create_unmanaged_ex calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_create_core_ex in a wrapper, trust the macro and don't call apr_pool_create_core_ex_debug directly. </dd></dl>
</div>
</div>
<a id="ga54759954d2cba7cb649ab5680a33f9e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga54759954d2cba7cb649ab5680a33f9e3">◆ </a></span>apr_pool_destroy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_pool_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the pool. This takes similar action as <a class="el" href="group__apr__pools.html#gafa8a998cd660e82b62aecec09e239d0d">apr_pool_clear()</a> and then frees all the memory. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pool to destroy </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>This will actually free the memory </dd></dl>
</div>
</div>
<a id="ga7efe64dfcce883d7fad9df813d9259fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7efe64dfcce883d7fad9df813d9259fc">◆ </a></span>apr_pool_destroy_debug()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_pool_destroy_debug </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file_line</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug version of apr_pool_destroy. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>See: apr_pool_destroy. </td></tr>
<tr><td class="paramname">file_line</td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Only available when APR_POOL_DEBUG is defined. Call this directly if you have your apr_pool_destroy calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_destroy in a wrapper, trust the macro and don't call apr_pool_destroy_debug directly. </dd></dl>
</div>
</div>
<a id="gad64a6a29515621bc13f8a8da50366d67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad64a6a29515621bc13f8a8da50366d67">◆ </a></span>apr_pool_initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_initialize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setup all of the internal structures required to use pools </p><dl class="section remark"><dt>Remarks</dt><dd>Programs do NOT need to call this directly. APR will call this automatically from apr_initialize. </dd></dl>
</div>
</div>
<a id="ga05d299f778659d1e0806140d8a7fea79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga05d299f778659d1e0806140d8a7fea79">◆ </a></span>apr_pool_is_ancestor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int apr_pool_is_ancestor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if pool a is an ancestor of pool b. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>The pool to search </td></tr>
<tr><td class="paramname">b</td><td>The pool to search for </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if a is an ancestor of b, NULL is considered an ancestor of all pools. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>if compiled with APR_POOL_DEBUG, this function will also return true if A is a pool which has been guaranteed by the caller (using apr_pool_join) to have a lifetime at least as long as some ancestor of pool B. </dd></dl>
</div>
</div>
<a id="ga94db31f40609b15b592ff47f989ca9ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga94db31f40609b15b592ff47f989ca9ec">◆ </a></span>apr_pool_parent_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a>* apr_pool_parent_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the parent pool of the specified pool. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pool</td><td>The pool for retrieving the parent pool. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The parent of the given pool. </dd></dl>
</div>
</div>
<a id="gaeaa872f7999740a60803e95429890518"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaeaa872f7999740a60803e95429890518">◆ </a></span>apr_pool_tag()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_pool_tag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>tag</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tag a pool (give it a name) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pool</td><td>The pool to tag </td></tr>
<tr><td class="paramname">tag</td><td>The tag </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga3728aacec227318cef973b8a33f3b430"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3728aacec227318cef973b8a33f3b430">◆ </a></span>apr_pool_terminate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_pool_terminate </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tear down all of the internal structures required to use pools </p><dl class="section remark"><dt>Remarks</dt><dd>Programs do NOT need to call this directly. APR will call this automatically from apr_terminate. </dd></dl>
</div>
</div>
<a id="gaf930f1fad2cf92a2432c0814c8a0b86f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf930f1fad2cf92a2432c0814c8a0b86f">◆ </a></span>apr_pool_userdata_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_userdata_get </td>
<td>(</td>
<td class="paramtype">void ** </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the data associated with the current pool. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The user data associated with the pool. </td></tr>
<tr><td class="paramname">key</td><td>The key for the data to retrieve </td></tr>
<tr><td class="paramname">pool</td><td>The current pool. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga78d1aa2d9fa842d83eaffccb0f0c0c5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga78d1aa2d9fa842d83eaffccb0f0c0c5c">◆ </a></span>apr_pool_userdata_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_userdata_set </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>(*)(void *) </td>
<td class="paramname"><em>cleanup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the data associated with the current pool </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The user data associated with the pool. </td></tr>
<tr><td class="paramname">key</td><td>The key to use for association </td></tr>
<tr><td class="paramname">cleanup</td><td>The cleanup program to use to cleanup the data (NULL if none) </td></tr>
<tr><td class="paramname">pool</td><td>The current pool </td></tr>
</table>
</dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>The data to be attached to the pool should have a life span at least as long as the pool it is being attached to.</dd></dl>
<p>Users of APR must take EXTREME care when choosing a key to use for their data. It is possible to accidentally overwrite data by choosing a key that another part of the program is using. Therefore it is advised that steps are taken to ensure that unique keys are used for all of the userdata objects in a particular pool (the same key in two different pools or a pool and one of its subpools is okay) at all times. Careful namespace prefixing of key names is a typical way to help ensure this uniqueness. </p>
</div>
</div>
<a id="ga435644c493dc5b10d80c4b99b8cd4589"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga435644c493dc5b10d80c4b99b8cd4589">◆ </a></span>apr_pool_userdata_setn()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_pool_userdata_setn </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>(*)(void *) </td>
<td class="paramname"><em>cleanup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td>
<td class="paramname"><em>pool</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the data associated with the current pool </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The user data associated with the pool. </td></tr>
<tr><td class="paramname">key</td><td>The key to use for association </td></tr>
<tr><td class="paramname">cleanup</td><td>The cleanup program to use to cleanup the data (NULL if none) </td></tr>
<tr><td class="paramname">pool</td><td>The current pool </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>same as <a class="el" href="group__apr__pools.html#ga78d1aa2d9fa842d83eaffccb0f0c0c5c">apr_pool_userdata_set()</a>, except that this version doesn't make a copy of the key (this function is useful, for example, when the key is a string literal) </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>This should NOT be used if the key could change addresses by any means between the <a class="el" href="group__apr__pools.html#ga435644c493dc5b10d80c4b99b8cd4589">apr_pool_userdata_setn()</a> call and a subsequent <a class="el" href="group__apr__pools.html#gaf930f1fad2cf92a2432c0814c8a0b86f">apr_pool_userdata_get()</a> on that key, such as if a static string is used as a userdata key in a DSO and the DSO could be unloaded and reloaded between the _setn() and the _get(). You MUST use <a class="el" href="group__apr__pools.html#ga78d1aa2d9fa842d83eaffccb0f0c0c5c">apr_pool_userdata_set()</a> in such cases. </dd>
<dd>
More generally, the key and the data to be attached to the pool should have a life span at least as long as the pool itself. </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>
