<!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: apr_dbm.h Source File</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.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.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)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>apr_dbm.h</h1> </div>
</div>
<div class="contents">
<a href="apr__dbm_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_DBM_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_DBM_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "apu.h"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="apr_8h.html" title="APR Platform Definitions.">apr.h</a>"</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html" title="APR Error Codes.">apr_errno.h</a>"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="apr__file__info_8h.html" title="APR File Information.">apr_file_info.h</a>"</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00028"></a>00028 <span class="preprocessor">#endif</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">/**</span>
<a name="l00031"></a>00031 <span class="comment"> * @file apr_dbm.h</span>
<a name="l00032"></a>00032 <span class="comment"> * @brief APR-UTIL DBM library</span>
<a name="l00033"></a>00033 <span class="comment"> */</span><span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/** </span>
<a name="l00035"></a>00035 <span class="comment"> * @defgroup APR_Util_DBM DBM routines</span>
<a name="l00036"></a>00036 <span class="comment"> * @ingroup APR_Util</span>
<a name="l00037"></a>00037 <span class="comment"> * @{</span>
<a name="l00038"></a>00038 <span class="comment"> */</span><span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">/**</span>
<a name="l00040"></a>00040 <span class="comment"> * Structure for referencing a dbm</span>
<a name="l00041"></a>00041 <span class="comment"> */</span>
<a name="l00042"></a><a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">00042</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> <a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a>;
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">/**</span>
<a name="l00045"></a>00045 <span class="comment"> * Structure for referencing the datum record within a dbm</span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a><a class="code" href="structapr__datum__t.html">00047</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00048"></a>00048 {<span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment"> /** pointer to the 'data' to retrieve/store in the DBM */</span>
<a name="l00050"></a><a class="code" href="structapr__datum__t.html#a7f4e0997f26d818c5674446ebb3d58bb">00050</a> <span class="keywordtype">char</span> *<a class="code" href="structapr__datum__t.html#a7f4e0997f26d818c5674446ebb3d58bb">dptr</a>;<span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment"> /** size of the 'data' to retrieve/store in the DBM */</span>
<a name="l00052"></a><a class="code" href="structapr__datum__t.html#a5b58c23a5f65a8a6e3f8228fef5e429c">00052</a> apr_size_t <a class="code" href="structapr__datum__t.html#a5b58c23a5f65a8a6e3f8228fef5e429c">dsize</a>;
<a name="l00053"></a>00053 } <a class="code" href="structapr__datum__t.html">apr_datum_t</a>;
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">/* modes to open the DB */</span>
<a name="l00056"></a><a class="code" href="group___a_p_r___util___d_b_m.html#gacd6e9c0783bd0c232bdd02b14655b6b1">00056</a> <span class="preprocessor">#define APR_DBM_READONLY 1 </span><span class="comment">/**< open for read-only access */</span>
<a name="l00057"></a><a class="code" href="group___a_p_r___util___d_b_m.html#gaf693166e76d6f84b12a0d75307687053">00057</a> <span class="preprocessor">#define APR_DBM_READWRITE 2 </span><span class="comment">/**< open for read-write access */</span>
<a name="l00058"></a><a class="code" href="group___a_p_r___util___d_b_m.html#gabf461a27dab1f4cc7405e891d2ad6522">00058</a> <span class="preprocessor">#define APR_DBM_RWCREATE 3 </span><span class="comment">/**< open for r/w, create if needed */</span>
<a name="l00059"></a><a class="code" href="group___a_p_r___util___d_b_m.html#ga8bffe207158704162c24fa74dc1b9264">00059</a> <span class="preprocessor">#define APR_DBM_RWTRUNC 4 </span><span class="comment">/**< open for r/w, truncating an existing</span>
<a name="l00060"></a>00060 <span class="comment"> DB if present */</span>
<a name="l00061"></a>00061 <span class="comment">/**</span>
<a name="l00062"></a>00062 <span class="comment"> * Open a dbm file by file name and type of DBM</span>
<a name="l00063"></a>00063 <span class="comment"> * @param dbm The newly opened database</span>
<a name="l00064"></a>00064 <span class="comment"> * @param type The type of the DBM (not all may be available at run time)</span>
<a name="l00065"></a>00065 <span class="comment"> * <pre></span>
<a name="l00066"></a>00066 <span class="comment"> * db for Berkeley DB files</span>
<a name="l00067"></a>00067 <span class="comment"> * gdbm for GDBM files</span>
<a name="l00068"></a>00068 <span class="comment"> * ndbm for NDBM files</span>
<a name="l00069"></a>00069 <span class="comment"> * sdbm for SDBM files (always available)</span>
<a name="l00070"></a>00070 <span class="comment"> * default for the default DBM type</span>
<a name="l00071"></a>00071 <span class="comment"> * </pre></span>
<a name="l00072"></a>00072 <span class="comment"> * @param name The dbm file name to open</span>
<a name="l00073"></a>00073 <span class="comment"> * @param mode The flag value</span>
<a name="l00074"></a>00074 <span class="comment"> * <PRE></span>
<a name="l00075"></a>00075 <span class="comment"> * APR_DBM_READONLY open for read-only access</span>
<a name="l00076"></a>00076 <span class="comment"> * APR_DBM_READWRITE open for read-write access</span>
<a name="l00077"></a>00077 <span class="comment"> * APR_DBM_RWCREATE open for r/w, create if needed</span>
<a name="l00078"></a>00078 <span class="comment"> * APR_DBM_RWTRUNC open for r/w, truncate if already there</span>
<a name="l00079"></a>00079 <span class="comment"> * </PRE></span>
<a name="l00080"></a>00080 <span class="comment"> * @param perm Permissions to apply to if created</span>
<a name="l00081"></a>00081 <span class="comment"> * @param cntxt The pool to use when creating the dbm</span>
<a name="l00082"></a>00082 <span class="comment"> * @remark The dbm name may not be a true file name, as many dbm packages</span>
<a name="l00083"></a>00083 <span class="comment"> * append suffixes for seperate data and index files.</span>
<a name="l00084"></a>00084 <span class="comment"> * @bug In apr-util 0.9 and 1.x, the type arg was case insensitive. This</span>
<a name="l00085"></a>00085 <span class="comment"> * was highly inefficient, and as of 2.x the dbm name must be provided in</span>
<a name="l00086"></a>00086 <span class="comment"> * the correct case (lower case for all bundled providers)</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088
<a name="l00089"></a>00089 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_m.html#gaf7295ba8157f487b78319e168e1344b4">apr_dbm_open_ex</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> **dbm, const <span class="keywordtype">char</span>* type,
<a name="l00090"></a>00090 const <span class="keywordtype">char</span> *name,
<a name="l00091"></a>00091 apr_int32_t mode, <a class="code" href="group__apr__file__info.html#ga3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perm,
<a name="l00092"></a>00092 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *cntxt);
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">/**</span>
<a name="l00096"></a>00096 <span class="comment"> * Open a dbm file by file name</span>
<a name="l00097"></a>00097 <span class="comment"> * @param dbm The newly opened database</span>
<a name="l00098"></a>00098 <span class="comment"> * @param name The dbm file name to open</span>
<a name="l00099"></a>00099 <span class="comment"> * @param mode The flag value</span>
<a name="l00100"></a>00100 <span class="comment"> * <PRE></span>
<a name="l00101"></a>00101 <span class="comment"> * APR_DBM_READONLY open for read-only access</span>
<a name="l00102"></a>00102 <span class="comment"> * APR_DBM_READWRITE open for read-write access</span>
<a name="l00103"></a>00103 <span class="comment"> * APR_DBM_RWCREATE open for r/w, create if needed</span>
<a name="l00104"></a>00104 <span class="comment"> * APR_DBM_RWTRUNC open for r/w, truncate if already there</span>
<a name="l00105"></a>00105 <span class="comment"> * </PRE></span>
<a name="l00106"></a>00106 <span class="comment"> * @param perm Permissions to apply to if created</span>
<a name="l00107"></a>00107 <span class="comment"> * @param cntxt The pool to use when creating the dbm</span>
<a name="l00108"></a>00108 <span class="comment"> * @remark The dbm name may not be a true file name, as many dbm packages</span>
<a name="l00109"></a>00109 <span class="comment"> * append suffixes for seperate data and index files.</span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a>00111 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_m.html#gab2d9cc87f4922ae11a175556ec66e390">apr_dbm_open</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> **dbm, const <span class="keywordtype">char</span> *name,
<a name="l00112"></a>00112 apr_int32_t mode, <a class="code" href="group__apr__file__info.html#ga3af19c4c47007169064a70f9351bc7d8">apr_fileperms_t</a> perm,
<a name="l00113"></a>00113 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *cntxt);
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">/**</span>
<a name="l00116"></a>00116 <span class="comment"> * Close a dbm file previously opened by apr_dbm_open</span>
<a name="l00117"></a>00117 <span class="comment"> * @param dbm The database to close</span>
<a name="l00118"></a>00118 <span class="comment"> */</span>
<a name="l00119"></a>00119 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group___a_p_r___util___d_b_m.html#gaad1e796c7436bf855ce6ec3c567eb3eb">apr_dbm_close</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm);
<a name="l00120"></a>00120 <span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment">/**</span>
<a name="l00122"></a>00122 <span class="comment"> * Fetch a dbm record value by key</span>
<a name="l00123"></a>00123 <span class="comment"> * @param dbm The database </span>
<a name="l00124"></a>00124 <span class="comment"> * @param key The key datum to find this record</span>
<a name="l00125"></a>00125 <span class="comment"> * @param pvalue The value datum retrieved for this record</span>
<a name="l00126"></a>00126 <span class="comment"> */</span>
<a name="l00127"></a>00127 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_m.html#gac990e695db20e3fa6998089081685196">apr_dbm_fetch</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm, <a class="code" href="structapr__datum__t.html">apr_datum_t</a> key,
<a name="l00128"></a>00128 <a class="code" href="structapr__datum__t.html">apr_datum_t</a> *pvalue);<span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment">/**</span>
<a name="l00130"></a>00130 <span class="comment"> * Store a dbm record value by key</span>
<a name="l00131"></a>00131 <span class="comment"> * @param dbm The database </span>
<a name="l00132"></a>00132 <span class="comment"> * @param key The key datum to store this record by</span>
<a name="l00133"></a>00133 <span class="comment"> * @param value The value datum to store in this record</span>
<a name="l00134"></a>00134 <span class="comment"> */</span>
<a name="l00135"></a>00135 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_m.html#ga014a6acf6f86aaac5fc44af5b8951051">apr_dbm_store</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm, <a class="code" href="structapr__datum__t.html">apr_datum_t</a> key,
<a name="l00136"></a>00136 <a class="code" href="structapr__datum__t.html">apr_datum_t</a> value);
<a name="l00137"></a>00137 <span class="comment"></span>
<a name="l00138"></a>00138 <span class="comment">/**</span>
<a name="l00139"></a>00139 <span class="comment"> * Delete a dbm record value by key</span>
<a name="l00140"></a>00140 <span class="comment"> * @param dbm The database </span>
<a name="l00141"></a>00141 <span class="comment"> * @param key The key datum of the record to delete</span>
<a name="l00142"></a>00142 <span class="comment"> * @remark It is not an error to delete a non-existent record.</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a>00144 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_m.html#ga3b218881f3bb9f8e909f32d99ae2ad34">apr_dbm_delete</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm, <a class="code" href="structapr__datum__t.html">apr_datum_t</a> key);
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment">/**</span>
<a name="l00147"></a>00147 <span class="comment"> * Search for a key within the dbm</span>
<a name="l00148"></a>00148 <span class="comment"> * @param dbm The database </span>
<a name="l00149"></a>00149 <span class="comment"> * @param key The datum describing a key to test</span>
<a name="l00150"></a>00150 <span class="comment"> */</span>
<a name="l00151"></a>00151 APU_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group___a_p_r___util___d_b_m.html#ga20379004362aeeef11166bdaa8c47d1e">apr_dbm_exists</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm, <a class="code" href="structapr__datum__t.html">apr_datum_t</a> key);
<a name="l00152"></a>00152 <span class="comment"></span>
<a name="l00153"></a>00153 <span class="comment">/**</span>
<a name="l00154"></a>00154 <span class="comment"> * Retrieve the first record key from a dbm</span>
<a name="l00155"></a>00155 <span class="comment"> * @param dbm The database </span>
<a name="l00156"></a>00156 <span class="comment"> * @param pkey The key datum of the first record</span>
<a name="l00157"></a>00157 <span class="comment"> */</span>
<a name="l00158"></a>00158 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_m.html#gae5428eaa8df9a036212c8fad60e95e3c">apr_dbm_firstkey</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm, <a class="code" href="structapr__datum__t.html">apr_datum_t</a> *pkey);
<a name="l00159"></a>00159 <span class="comment"></span>
<a name="l00160"></a>00160 <span class="comment">/**</span>
<a name="l00161"></a>00161 <span class="comment"> * Retrieve the next record key from a dbm</span>
<a name="l00162"></a>00162 <span class="comment"> * @param dbm The database </span>
<a name="l00163"></a>00163 <span class="comment"> * @param pkey The key datum of the next record</span>
<a name="l00164"></a>00164 <span class="comment"> */</span>
<a name="l00165"></a>00165 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_m.html#ga92b8233ccf421b89d2144f834dd6f9a6">apr_dbm_nextkey</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm, <a class="code" href="structapr__datum__t.html">apr_datum_t</a> *pkey);
<a name="l00166"></a>00166 <span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment">/**</span>
<a name="l00168"></a>00168 <span class="comment"> * Proactively toss any memory associated with the apr_datum_t.</span>
<a name="l00169"></a>00169 <span class="comment"> * @param dbm The database </span>
<a name="l00170"></a>00170 <span class="comment"> * @param data The datum to free.</span>
<a name="l00171"></a>00171 <span class="comment"> */</span>
<a name="l00172"></a>00172 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group___a_p_r___util___d_b_m.html#gacd9f6bc4a633720ac882daba9e0d9873">apr_dbm_freedatum</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm, <a class="code" href="structapr__datum__t.html">apr_datum_t</a> data);
<a name="l00173"></a>00173 <span class="comment"></span>
<a name="l00174"></a>00174 <span class="comment">/**</span>
<a name="l00175"></a>00175 <span class="comment"> * Report more information when an apr_dbm function fails.</span>
<a name="l00176"></a>00176 <span class="comment"> * @param dbm The database</span>
<a name="l00177"></a>00177 <span class="comment"> * @param errcode A DBM-specific value for the error (for logging). If this</span>
<a name="l00178"></a>00178 <span class="comment"> * isn't needed, it may be NULL.</span>
<a name="l00179"></a>00179 <span class="comment"> * @param errbuf Location to store the error text</span>
<a name="l00180"></a>00180 <span class="comment"> * @param errbufsize The size of the provided buffer</span>
<a name="l00181"></a>00181 <span class="comment"> * @return The errbuf parameter, for convenience.</span>
<a name="l00182"></a>00182 <span class="comment"> */</span>
<a name="l00183"></a>00183 APU_DECLARE(<span class="keywordtype">char</span> *) <a class="code" href="group___a_p_r___util___d_b_m.html#ga597bd9e35de9575afb55b3326789c0f3">apr_dbm_geterror</a>(<a class="code" href="group___a_p_r___util___d_b_m.html#ga47f6ff771143ed7b7987c686c20c8536">apr_dbm_t</a> *dbm, <span class="keywordtype">int</span> *errcode,
<a name="l00184"></a>00184 <span class="keywordtype">char</span> *errbuf, apr_size_t errbufsize);<span class="comment"></span>
<a name="l00185"></a>00185 <span class="comment">/**</span>
<a name="l00186"></a>00186 <span class="comment"> * If the specified file/path were passed to apr_dbm_open(), return the</span>
<a name="l00187"></a>00187 <span class="comment"> * actual file/path names which would be (created and) used. At most, two</span>
<a name="l00188"></a>00188 <span class="comment"> * files may be used; used2 may be NULL if only one file is used.</span>
<a name="l00189"></a>00189 <span class="comment"> * @param pool The pool for allocating used1 and used2.</span>
<a name="l00190"></a>00190 <span class="comment"> * @param type The type of DBM you require info on @see apr_dbm_open_ex</span>
<a name="l00191"></a>00191 <span class="comment"> * @param pathname The path name to generate used-names from.</span>
<a name="l00192"></a>00192 <span class="comment"> * @param used1 The first pathname used by the apr_dbm implementation.</span>
<a name="l00193"></a>00193 <span class="comment"> * @param used2 The second pathname used by apr_dbm. If only one file is</span>
<a name="l00194"></a>00194 <span class="comment"> * used by the specific implementation, this will be set to NULL.</span>
<a name="l00195"></a>00195 <span class="comment"> * @return An error if the specified type is invalid.</span>
<a name="l00196"></a>00196 <span class="comment"> * @remark The dbm file(s) don't need to exist. This function only manipulates</span>
<a name="l00197"></a>00197 <span class="comment"> * the pathnames.</span>
<a name="l00198"></a>00198 <span class="comment"> */</span>
<a name="l00199"></a>00199 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___d_b_m.html#ga7a3a1bd1ece38d90739ecb7cf72bf4fb">apr_dbm_get_usednames_ex</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
<a name="l00200"></a>00200 const <span class="keywordtype">char</span> *type,
<a name="l00201"></a>00201 const <span class="keywordtype">char</span> *pathname,
<a name="l00202"></a>00202 const <span class="keywordtype">char</span> **used1,
<a name="l00203"></a>00203 const <span class="keywordtype">char</span> **used2);
<a name="l00204"></a>00204 <span class="comment"></span>
<a name="l00205"></a>00205 <span class="comment">/**</span>
<a name="l00206"></a>00206 <span class="comment"> * If the specified file/path were passed to apr_dbm_open(), return the</span>
<a name="l00207"></a>00207 <span class="comment"> * actual file/path names which would be (created and) used. At most, two</span>
<a name="l00208"></a>00208 <span class="comment"> * files may be used; used2 may be NULL if only one file is used.</span>
<a name="l00209"></a>00209 <span class="comment"> * @param pool The pool for allocating used1 and used2.</span>
<a name="l00210"></a>00210 <span class="comment"> * @param pathname The path name to generate used-names from.</span>
<a name="l00211"></a>00211 <span class="comment"> * @param used1 The first pathname used by the apr_dbm implementation.</span>
<a name="l00212"></a>00212 <span class="comment"> * @param used2 The second pathname used by apr_dbm. If only one file is</span>
<a name="l00213"></a>00213 <span class="comment"> * used by the specific implementation, this will be set to NULL.</span>
<a name="l00214"></a>00214 <span class="comment"> * @remark The dbm file(s) don't need to exist. This function only manipulates</span>
<a name="l00215"></a>00215 <span class="comment"> * the pathnames.</span>
<a name="l00216"></a>00216 <span class="comment"> */</span>
<a name="l00217"></a>00217 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group___a_p_r___util___d_b_m.html#ga1ee45897c5e1b0718dfa4bd35a75dbe1">apr_dbm_get_usednames</a>(<a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool,
<a name="l00218"></a>00218 const <span class="keywordtype">char</span> *pathname,
<a name="l00219"></a>00219 const <span class="keywordtype">char</span> **used1,
<a name="l00220"></a>00220 const <span class="keywordtype">char</span> **used2);
<a name="l00221"></a>00221 <span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment">/** @} */</span>
<a name="l00223"></a>00223 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00224"></a>00224 <span class="preprocessor"></span>}
<a name="l00225"></a>00225 <span class="preprocessor">#endif</span>
<a name="l00226"></a>00226 <span class="preprocessor"></span>
<a name="l00227"></a>00227 <span class="preprocessor">#endif </span><span class="comment">/* !APR_DBM_H */</span>
</pre></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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><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 class="footer"><small>Generated on Tue Feb 8 2011 for Apache Portable Runtime by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
