<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!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"/>
<title>Apache Portable Runtime: Hash Tables</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>Hash Tables<br/>
<small>
[<a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga3ba32541f2717b394000f87f38c7e12d">APR_HASH_KEY_STRING</a> (-1)</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef unsigned int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga083e92cab31343c1ebb9073275e8166e">apr_hashfunc_t</a> )(const char *key, apr_ssize_t *klen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int( </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga31696b2d87fbc5b626887a59f5ebb7d1">apr_hash_do_callback_fn_t</a> )(void *rec, const void *key, apr_ssize_t klen, const void *value)</td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga8baa6e9d9d6c2c496d2a0ff1a5c53abe">apr_hashfunc_default</a> (const char *key, apr_ssize_t *klen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga5f4b424d6761de4d32aa16ff6803bac9">apr_hash_make</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga27f40acb206f1821a783ddcb71bc8971">apr_hash_make_custom</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, <a class="el" href="group__apr__hash.html#ga083e92cab31343c1ebb9073275e8166e">apr_hashfunc_t</a> hash_func)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#gafa0b1b9fb91b2249ee3bcb645d93e148">apr_hash_copy</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool, const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *h)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga456beb139bc548728b49c09c2f89b93c">apr_hash_set</a> (<a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *ht, const void *key, apr_ssize_t klen, const void *val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga05e526dad8afaebe14caea90d906d6ec">apr_hash_get</a> (<a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *ht, const void *key, apr_ssize_t klen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga640005a4ba64a5db039b0b43a8ad4898">apr_hash_first</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *ht)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga9d7b9198555659e9abac4e3028ccce00">apr_hash_next</a> (<a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> *hi)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#gad90e5b895397c2c535e32b3e44a75b3f">apr_hash_this</a> (<a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> *hi, const void **key, apr_ssize_t *klen, void **val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga4e44efa9ef043c1bb8a4abc5edcfda2c">apr_hash_count</a> (<a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *ht)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga06fb1b9ecff1a15ee41ff02db74264e4">apr_hash_clear</a> (<a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *ht)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga2f68646a64bad44efcbf3457af581fdb">apr_hash_overlay</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *overlay, const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *base)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#gaa954266cd16a55f7f384ab0a9c4ff9f1">apr_hash_merge</a> (<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *h1, const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *h2, void *(*merger)(<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const void *key, apr_ssize_t klen, const void *h1_val, const void *h2_val, const void *data), const void *data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__hash.html#ga3f3bac64e281d9e7eb9fed6101031394">apr_hash_do</a> (<a class="el" href="group__apr__hash.html#ga31696b2d87fbc5b626887a59f5ebb7d1">apr_hash_do_callback_fn_t</a> *comp, void *rec, const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *ht)</td></tr>
<tr><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__hash.html#ga6c170fee4d679928d381cd61c559c105">apr_hash_pool_get</a> (const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *thehash)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ga3ba32541f2717b394000f87f38c7e12d"></a><!-- doxytag: member="apr_hash.h::APR_HASH_KEY_STRING" ref="ga3ba32541f2717b394000f87f38c7e12d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_HASH_KEY_STRING (-1)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>When passing a key to apr_hash_set or apr_hash_get, this value can be passed to indicate a string-valued key, and have apr_hash compute the length automatically.</p>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>apr_hash will use strlen(key) for the length. The NUL terminator is not included in the hash value (why throw a constant in?). Since the hash table merely references the provided key (rather than copying it), <a class="el" href="group__apr__hash.html#gad90e5b895397c2c535e32b3e44a75b3f">apr_hash_this()</a> will return the NUL-term'd key. </dd></dl>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga31696b2d87fbc5b626887a59f5ebb7d1"></a><!-- doxytag: member="apr_hash.h::apr_hash_do_callback_fn_t" ref="ga31696b2d87fbc5b626887a59f5ebb7d1" args=")(void *rec, const void *key, apr_ssize_t klen, const void *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int( <a class="el" href="group__apr__hash.html#ga31696b2d87fbc5b626887a59f5ebb7d1">apr_hash_do_callback_fn_t</a>)(void *rec, const void *key, apr_ssize_t klen, const void *value)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Declaration prototype for the iterator callback function of <a class="el" href="group__apr__hash.html#ga3f3bac64e281d9e7eb9fed6101031394">apr_hash_do()</a>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rec</em> </td><td>The data passed as the first argument to apr_hash_[v]do() </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key from this iteration of the hash table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>klen</em> </td><td>The key length from this iteration of the hash table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value from this iteration of the hash table </td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Iteration continues while this callback function returns non-zero. To export the callback function for <a class="el" href="group__apr__hash.html#ga3f3bac64e281d9e7eb9fed6101031394">apr_hash_do()</a> it must be declared in the _NONSTD convention. </dd></dl>
</div>
</div>
<a class="anchor" id="ga3b3d353989f6cea4535630634be147f7"></a><!-- doxytag: member="apr_hash.h::apr_hash_index_t" ref="ga3b3d353989f6cea4535630634be147f7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> <a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Abstract type for scanning hash tables. </p>
</div>
</div>
<a class="anchor" id="ga72ec09b8bde6d874c36bd49df915fff6"></a><!-- doxytag: member="apr_hash.h::apr_hash_t" ref="ga72ec09b8bde6d874c36bd49df915fff6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Abstract type for hash tables. </p>
</div>
</div>
<a class="anchor" id="ga083e92cab31343c1ebb9073275e8166e"></a><!-- doxytag: member="apr_hash.h::apr_hashfunc_t" ref="ga083e92cab31343c1ebb9073275e8166e" args=")(const char *key, apr_ssize_t *klen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef unsigned int(* <a class="el" href="group__apr__hash.html#ga083e92cab31343c1ebb9073275e8166e">apr_hashfunc_t</a>)(const char *key, apr_ssize_t *klen)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Callback functions for calculating hash values. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>klen</em> </td><td>The length of the key, or APR_HASH_KEY_STRING to use the string length. If APR_HASH_KEY_STRING then returns the actual key length. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga06fb1b9ecff1a15ee41ff02db74264e4"></a><!-- doxytag: member="apr_hash.h::apr_hash_clear" ref="ga06fb1b9ecff1a15ee41ff02db74264e4" args="(apr_hash_t *ht)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_hash_clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>ht</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear any key/value pairs in the hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ht</em> </td><td>The hash table </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gafa0b1b9fb91b2249ee3bcb645d93e148"></a><!-- doxytag: member="apr_hash.h::apr_hash_copy" ref="gafa0b1b9fb91b2249ee3bcb645d93e148" args="(apr_pool_t *pool, const apr_hash_t *h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a>* apr_hash_copy </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 <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>h</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Make a copy of a hash table </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool from which to allocate the new hash table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>h</em> </td><td>The hash table to clone </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The hash table just created </dd></dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>Makes a shallow copy </dd></dl>
</div>
</div>
<a class="anchor" id="ga4e44efa9ef043c1bb8a4abc5edcfda2c"></a><!-- doxytag: member="apr_hash.h::apr_hash_count" ref="ga4e44efa9ef043c1bb8a4abc5edcfda2c" args="(apr_hash_t *ht)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int apr_hash_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>ht</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of key/value pairs in the hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ht</em> </td><td>The hash table </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of key/value pairs in the hash table. </dd></dl>
</div>
</div>
<a class="anchor" id="ga3f3bac64e281d9e7eb9fed6101031394"></a><!-- doxytag: member="apr_hash.h::apr_hash_do" ref="ga3f3bac64e281d9e7eb9fed6101031394" args="(apr_hash_do_callback_fn_t *comp, void *rec, const apr_hash_t *ht)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int apr_hash_do </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__hash.html#ga31696b2d87fbc5b626887a59f5ebb7d1">apr_hash_do_callback_fn_t</a> * </td>
<td class="paramname"> <em>comp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>rec</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>ht</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate over a hash table running the provided function once for every element in the hash table. The </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>comp</em> </td><td>function will be invoked for every element in the hash table.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>comp</em> </td><td>The function to run </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rec</em> </td><td>The data to pass as the first argument to the function </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ht</em> </td><td>The hash table to iterate over </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>FALSE if one of the comp() iterations returned zero; TRUE if all iterations returned non-zero </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="group__apr__hash.html#ga31696b2d87fbc5b626887a59f5ebb7d1">apr_hash_do_callback_fn_t</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga640005a4ba64a5db039b0b43a8ad4898"></a><!-- doxytag: member="apr_hash.h::apr_hash_first" ref="ga640005a4ba64a5db039b0b43a8ad4898" args="(apr_pool_t *p, apr_hash_t *ht)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a>* apr_hash_first </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"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>ht</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start iterating over the entries in a hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool to allocate the apr_hash_index_t iterator. If this pool is NULL, then an internal, non-thread-safe iterator is used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ht</em> </td><td>The hash table </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The iteration state </dd></dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>There is no restriction on adding or deleting hash entries during an iteration (although the results may be unpredictable unless all you do is delete the current entry) and multiple iterations can be in progress at the same time.</dd></dl>
<dl class="user"><dt><b>Example:</b></dt><dd></dd></dl>
<div class="fragment"><pre class="fragment"> <span class="keywordtype">int</span> sum_values(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, <a class="code" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> *ht)
{
<a class="code" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> *hi;
<span class="keywordtype">void</span> *val;
<span class="keywordtype">int</span> sum = 0;
<span class="keywordflow">for</span> (hi = <a class="code" href="group__apr__hash.html#ga640005a4ba64a5db039b0b43a8ad4898">apr_hash_first</a>(p, ht); hi; hi = <a class="code" href="group__apr__hash.html#ga9d7b9198555659e9abac4e3028ccce00">apr_hash_next</a>(hi)) {
<a class="code" href="group__apr__hash.html#gad90e5b895397c2c535e32b3e44a75b3f">apr_hash_this</a>(hi, NULL, NULL, &val);
sum += *(<span class="keywordtype">int</span> *)val;
}
<span class="keywordflow">return</span> sum;
}
</pre></div>
</div>
</div>
<a class="anchor" id="ga05e526dad8afaebe14caea90d906d6ec"></a><!-- doxytag: member="apr_hash.h::apr_hash_get" ref="ga05e526dad8afaebe14caea90d906d6ec" args="(apr_hash_t *ht, const void *key, apr_ssize_t klen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* apr_hash_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>ht</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_ssize_t </td>
<td class="paramname"> <em>klen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Look up the value associated with a key in a hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ht</em> </td><td>The hash table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Pointer to the key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>klen</em> </td><td>Length of the key. Can be APR_HASH_KEY_STRING to use the string length. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns NULL if the key is not present. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5f4b424d6761de4d32aa16ff6803bac9"></a><!-- doxytag: member="apr_hash.h::apr_hash_make" ref="ga5f4b424d6761de4d32aa16ff6803bac9" args="(apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a>* apr_hash_make </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>Create a hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool to allocate the hash table out of </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The hash table just created </dd></dl>
</div>
</div>
<a class="anchor" id="ga27f40acb206f1821a783ddcb71bc8971"></a><!-- doxytag: member="apr_hash.h::apr_hash_make_custom" ref="ga27f40acb206f1821a783ddcb71bc8971" args="(apr_pool_t *pool, apr_hashfunc_t hash_func)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a>* apr_hash_make_custom </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"><a class="el" href="group__apr__hash.html#ga083e92cab31343c1ebb9073275e8166e">apr_hashfunc_t</a> </td>
<td class="paramname"> <em>hash_func</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a hash table with a custom hash function </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool to allocate the hash table out of </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hash_func</em> </td><td>A custom hash function. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The hash table just created </dd></dl>
</div>
</div>
<a class="anchor" id="gaa954266cd16a55f7f384ab0a9c4ff9f1"></a><!-- doxytag: member="apr_hash.h::apr_hash_merge" ref="gaa954266cd16a55f7f384ab0a9c4ff9f1" args="(apr_pool_t *p, const apr_hash_t *h1, const apr_hash_t *h2, void *(*merger)(apr_pool_t *p, const void *key, apr_ssize_t klen, const void *h1_val, const void *h2_val, const void *data), const void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a>* apr_hash_merge </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 <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>h1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>h2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *(*)(<a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, const void *key, apr_ssize_t klen, const void *h1_val, const void *h2_val, const void *data) </td>
<td class="paramname"> <em>merger</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Merge two hash tables into one new hash table. If the same key is present in both tables, call the supplied merge function to produce a merged value for the key in the new table. Both hash tables must use the same hash function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool to use for the new hash table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>h1</em> </td><td>The first of the tables to merge </td></tr>
<tr><td valign="top"></td><td valign="top"><em>h2</em> </td><td>The second of the tables to merge </td></tr>
<tr><td valign="top"></td><td valign="top"><em>merger</em> </td><td>A callback function to merge values, or NULL to make values from h1 override values from h2 (same semantics as <a class="el" href="group__apr__hash.html#ga2f68646a64bad44efcbf3457af581fdb">apr_hash_overlay()</a>) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Client data to pass to the merger function </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new hash table containing all of the data from the two passed in </dd></dl>
</div>
</div>
<a class="anchor" id="ga9d7b9198555659e9abac4e3028ccce00"></a><!-- doxytag: member="apr_hash.h::apr_hash_next" ref="ga9d7b9198555659e9abac4e3028ccce00" args="(apr_hash_index_t *hi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a>* apr_hash_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> * </td>
<td class="paramname"> <em>hi</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Continue iterating over the entries in a hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hi</em> </td><td>The iteration state </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to the updated iteration state. NULL if there are no more entries. </dd></dl>
</div>
</div>
<a class="anchor" id="ga2f68646a64bad44efcbf3457af581fdb"></a><!-- doxytag: member="apr_hash.h::apr_hash_overlay" ref="ga2f68646a64bad44efcbf3457af581fdb" args="(apr_pool_t *p, const apr_hash_t *overlay, const apr_hash_t *base)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a>* apr_hash_overlay </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 <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>overlay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>base</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Merge two hash tables into one new hash table. The values of the overlay hash override the values of the base if both have the same key. Both hash tables must use the same hash function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool to use for the new hash table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>overlay</em> </td><td>The table to add to the initial table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>base</em> </td><td>The table that represents the initial values of the new table </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new hash table containing all of the data from the two passed in </dd></dl>
</div>
</div>
<a class="anchor" id="ga6c170fee4d679928d381cd61c559c105"></a><!-- doxytag: member="apr_hash.h::apr_hash_pool_get" ref="ga6c170fee4d679928d381cd61c559c105" args="(const apr_hash_t *thehash)" -->
<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_hash_pool_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>thehash</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to the pool which the hash table was created in </p>
</div>
</div>
<a class="anchor" id="ga456beb139bc548728b49c09c2f89b93c"></a><!-- doxytag: member="apr_hash.h::apr_hash_set" ref="ga456beb139bc548728b49c09c2f89b93c" args="(apr_hash_t *ht, const void *key, apr_ssize_t klen, const void *val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_hash_set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__hash.html#ga72ec09b8bde6d874c36bd49df915fff6">apr_hash_t</a> * </td>
<td class="paramname"> <em>ht</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_ssize_t </td>
<td class="paramname"> <em>klen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Associate a value with a key in a hash table. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ht</em> </td><td>The hash table </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Pointer to the key </td></tr>
<tr><td valign="top"></td><td valign="top"><em>klen</em> </td><td>Length of the key. Can be APR_HASH_KEY_STRING to use the string length. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>Value to associate with the key </td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>If the value is NULL the hash entry is deleted. </dd></dl>
</div>
</div>
<a class="anchor" id="gad90e5b895397c2c535e32b3e44a75b3f"></a><!-- doxytag: member="apr_hash.h::apr_hash_this" ref="gad90e5b895397c2c535e32b3e44a75b3f" args="(apr_hash_index_t *hi, const void **key, apr_ssize_t *klen, void **val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void apr_hash_this </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__hash.html#ga3b3d353989f6cea4535630634be147f7">apr_hash_index_t</a> * </td>
<td class="paramname"> <em>hi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void ** </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_ssize_t * </td>
<td class="paramname"> <em>klen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the current entry's details from the iteration state. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>hi</em> </td><td>The iteration state </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>Return pointer for the pointer to the key. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>klen</em> </td><td>Return pointer for the key length. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>Return pointer for the associated value. </td></tr>
</table>
</dd>
</dl>
<dl class="remark"><dt><b>Remarks:</b></dt><dd>The return pointers should point to a variable that will be set to the corresponding data, or they may be NULL if the data isn't interesting. </dd></dl>
</div>
</div>
<a class="anchor" id="ga8baa6e9d9d6c2c496d2a0ff1a5c53abe"></a><!-- doxytag: member="apr_hash.h::apr_hashfunc_default" ref="ga8baa6e9d9d6c2c496d2a0ff1a5c53abe" args="(const char *key, apr_ssize_t *klen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int apr_hashfunc_default </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">apr_ssize_t * </td>
<td class="paramname"> <em>klen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default hash function. </p>
</div>
</div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Feb 14 10:09:01 2012 for Apache Portable Runtime by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
e0236b39c613e86bcee76bad717809a5
>
files
>
204
