<!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 Utility Library: SDBM library</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 Utility Library </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="#nested-classes">Data Structures</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">SDBM library<div class="ingroups"><a class="el" href="group___a_p_r___util.html">APR Utility Functions</a> » <a class="el" href="group___a_p_r___util___d_b_m.html">DBM routines</a></div></div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</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:gafabaf97932efa0eebfb1cc6b692a111f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gafabaf97932efa0eebfb1cc6b692a111f">APR_SDBM_DIRFEXT</a>   ".dir"</td></tr> <tr class="separator:gafabaf97932efa0eebfb1cc6b692a111f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa03fa1d1183240ca0845c54cc07df557"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gaa03fa1d1183240ca0845c54cc07df557">APR_SDBM_PAGFEXT</a>   ".pag"</td></tr> <tr class="separator:gaa03fa1d1183240ca0845c54cc07df557"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad42d896bab08b5e210f489fa59656807"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gad42d896bab08b5e210f489fa59656807">APR_SDBM_INSERT</a>   0</td></tr> <tr class="separator:gad42d896bab08b5e210f489fa59656807"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga84e2252c9ddf5e6c64ed1be43d2d0e53"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#ga84e2252c9ddf5e6c64ed1be43d2d0e53">APR_SDBM_REPLACE</a>   1</td></tr> <tr class="separator:ga84e2252c9ddf5e6c64ed1be43d2d0e53"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga64cd385609059cf151e54c7046d92ec3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#ga64cd385609059cf151e54c7046d92ec3">APR_SDBM_INSERTDUP</a>   2</td></tr> <tr class="separator:ga64cd385609059cf151e54c7046d92ec3"><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:gaf24cdea6e4884036a40484259efa68c6"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gaf24cdea6e4884036a40484259efa68c6">apr_sdbm_t</a></td></tr> <tr class="separator:gaf24cdea6e4884036a40484259efa68c6"><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:ga08c6121b4159ae86cec6e915e1e5d758"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#ga08c6121b4159ae86cec6e915e1e5d758">apr_sdbm_open</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> **db, const char *name, apr_int32_t mode, apr_fileperms_t perms, apr_pool_t *p)</td></tr> <tr class="separator:ga08c6121b4159ae86cec6e915e1e5d758"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf684c3a70d2c9ebe02bb1e2fffe23e1e"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gaf684c3a70d2c9ebe02bb1e2fffe23e1e">apr_sdbm_close</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db)</td></tr> <tr class="separator:gaf684c3a70d2c9ebe02bb1e2fffe23e1e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2c2edd6a123d8ca2a6334fa8874b724d"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#ga2c2edd6a123d8ca2a6334fa8874b724d">apr_sdbm_lock</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db, int type)</td></tr> <tr class="separator:ga2c2edd6a123d8ca2a6334fa8874b724d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab96a7e08ddac3cb6bff97a822b68de14"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gab96a7e08ddac3cb6bff97a822b68de14">apr_sdbm_unlock</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db)</td></tr> <tr class="separator:gab96a7e08ddac3cb6bff97a822b68de14"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7d9eae450e9f9a2f1bcf626a3f8ca43f"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#ga7d9eae450e9f9a2f1bcf626a3f8ca43f">apr_sdbm_fetch</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db, <a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> *value, <a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> key)</td></tr> <tr class="separator:ga7d9eae450e9f9a2f1bcf626a3f8ca43f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac12993b882c50afa0777945ea4a88572"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gac12993b882c50afa0777945ea4a88572">apr_sdbm_store</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db, <a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> key, <a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> value, int opt)</td></tr> <tr class="separator:gac12993b882c50afa0777945ea4a88572"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5744462c07c40d26c275beaeb902ff9c"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#ga5744462c07c40d26c275beaeb902ff9c">apr_sdbm_delete</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db, const <a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> key)</td></tr> <tr class="separator:ga5744462c07c40d26c275beaeb902ff9c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae5410d9dc681393e597f492f30c6447f"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gae5410d9dc681393e597f492f30c6447f">apr_sdbm_firstkey</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db, <a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> *key)</td></tr> <tr class="separator:gae5410d9dc681393e597f492f30c6447f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga77d7f848ccb68e9f465a988d0af80911"><td class="memItemLeft" align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#ga77d7f848ccb68e9f465a988d0af80911">apr_sdbm_nextkey</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db, <a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> *key)</td></tr> <tr class="separator:ga77d7f848ccb68e9f465a988d0af80911"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabad67008f83fd219173acc5abdd0b42d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___d_b_m___s_d_b_m.html#gabad67008f83fd219173acc5abdd0b42d">apr_sdbm_rdonly</a> (<a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> *db)</td></tr> <tr class="separator:gabad67008f83fd219173acc5abdd0b42d"><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="gafabaf97932efa0eebfb1cc6b692a111f"></a> <h2 class="memtitle"><span class="permalink"><a href="#gafabaf97932efa0eebfb1cc6b692a111f">◆ </a></span>APR_SDBM_DIRFEXT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_SDBM_DIRFEXT   ".dir"</td> </tr> </table> </div><div class="memdoc"> <p>SDBM Directory file extension </p> </div> </div> <a id="gad42d896bab08b5e210f489fa59656807"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad42d896bab08b5e210f489fa59656807">◆ </a></span>APR_SDBM_INSERT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_SDBM_INSERT   0</td> </tr> </table> </div><div class="memdoc"> <p>Insert </p> </div> </div> <a id="ga64cd385609059cf151e54c7046d92ec3"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga64cd385609059cf151e54c7046d92ec3">◆ </a></span>APR_SDBM_INSERTDUP</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_SDBM_INSERTDUP   2</td> </tr> </table> </div><div class="memdoc"> <p>Insert with duplicates </p> </div> </div> <a id="gaa03fa1d1183240ca0845c54cc07df557"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaa03fa1d1183240ca0845c54cc07df557">◆ </a></span>APR_SDBM_PAGFEXT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_SDBM_PAGFEXT   ".pag"</td> </tr> </table> </div><div class="memdoc"> <p>SDBM page file extension </p> </div> </div> <a id="ga84e2252c9ddf5e6c64ed1be43d2d0e53"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga84e2252c9ddf5e6c64ed1be43d2d0e53">◆ </a></span>APR_SDBM_REPLACE</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define APR_SDBM_REPLACE   1</td> </tr> </table> </div><div class="memdoc"> <p>Replace </p> </div> </div> <h2 class="groupheader">Typedef Documentation</h2> <a id="gaf24cdea6e4884036a40484259efa68c6"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaf24cdea6e4884036a40484259efa68c6">◆ </a></span>apr_sdbm_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> <a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a></td> </tr> </table> </div><div class="memdoc"> <p>Structure for referencing an sdbm </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="gaf684c3a70d2c9ebe02bb1e2fffe23e1e"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaf684c3a70d2c9ebe02bb1e2fffe23e1e">◆ </a></span>apr_sdbm_close()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_close </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Close an sdbm file previously opened by apr_sdbm_open </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database to close </td></tr> </table> </dd> </dl> </div> </div> <a id="ga5744462c07c40d26c275beaeb902ff9c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga5744462c07c40d26c275beaeb902ff9c">◆ </a></span>apr_sdbm_delete()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_delete </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> </td> <td class="paramname"><em>key</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Delete an sdbm record value by key </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database </td></tr> <tr><td class="paramname">key</td><td>The key datum of the record to delete </td></tr> </table> </dd> </dl> <dl class="section remark"><dt>Remarks</dt><dd>It is not an error to delete a non-existent record. </dd></dl> </div> </div> <a id="ga7d9eae450e9f9a2f1bcf626a3f8ca43f"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga7d9eae450e9f9a2f1bcf626a3f8ca43f">◆ </a></span>apr_sdbm_fetch()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_fetch </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> * </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> </td> <td class="paramname"><em>key</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Fetch an sdbm record value by key </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database </td></tr> <tr><td class="paramname">value</td><td>The value datum retrieved for this record </td></tr> <tr><td class="paramname">key</td><td>The key datum to find this record </td></tr> </table> </dd> </dl> </div> </div> <a id="gae5410d9dc681393e597f492f30c6447f"></a> <h2 class="memtitle"><span class="permalink"><a href="#gae5410d9dc681393e597f492f30c6447f">◆ </a></span>apr_sdbm_firstkey()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_firstkey </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> * </td> <td class="paramname"><em>key</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Retrieve the first record key from a dbm </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database </td></tr> <tr><td class="paramname">key</td><td>The key datum of the first record </td></tr> </table> </dd> </dl> <dl class="section remark"><dt>Remarks</dt><dd>The keys returned are not ordered. To traverse the list of keys for an sdbm opened with APR_SHARELOCK, the caller must use apr_sdbm_lock prior to retrieving the first record, and hold the lock until after the last call to apr_sdbm_nextkey. </dd></dl> </div> </div> <a id="ga2c2edd6a123d8ca2a6334fa8874b724d"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga2c2edd6a123d8ca2a6334fa8874b724d">◆ </a></span>apr_sdbm_lock()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_lock </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>type</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Lock an sdbm database for concurency of multiple operations </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database to lock </td></tr> <tr><td class="paramname">type</td><td>The lock type <pre> APR_FLOCK_SHARED APR_FLOCK_EXCLUSIVE </pre> </td></tr> </table> </dd> </dl> <dl class="section remark"><dt>Remarks</dt><dd>Calls to apr_sdbm_lock may be nested. All apr_sdbm functions perform implicit locking. Since an APR_FLOCK_SHARED lock cannot be portably promoted to an APR_FLOCK_EXCLUSIVE lock, apr_sdbm_store and apr_sdbm_delete calls will fail if an APR_FLOCK_SHARED lock is held. The apr_sdbm_lock call requires the database to be opened with the APR_SHARELOCK mode value. </dd></dl> </div> </div> <a id="ga77d7f848ccb68e9f465a988d0af80911"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga77d7f848ccb68e9f465a988d0af80911">◆ </a></span>apr_sdbm_nextkey()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_nextkey </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> * </td> <td class="paramname"><em>key</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Retrieve the next record key from an sdbm </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database </td></tr> <tr><td class="paramname">key</td><td>The key datum of the next record </td></tr> </table> </dd> </dl> </div> </div> <a id="ga08c6121b4159ae86cec6e915e1e5d758"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga08c6121b4159ae86cec6e915e1e5d758">◆ </a></span>apr_sdbm_open()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_open </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> ** </td> <td class="paramname"><em>db</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_int32_t </td> <td class="paramname"><em>mode</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_fileperms_t </td> <td class="paramname"><em>perms</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">apr_pool_t * </td> <td class="paramname"><em>p</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Open an sdbm database by file name </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The newly opened database </td></tr> <tr><td class="paramname">name</td><td>The sdbm file to open </td></tr> <tr><td class="paramname">mode</td><td>The flag values (APR_READ and APR_BINARY flags are implicit) <pre> APR_WRITE open for read-write access APR_CREATE create the sdbm if it does not exist APR_TRUNCATE empty the contents of the sdbm APR_EXCL fail for APR_CREATE if the file exists APR_DELONCLOSE delete the sdbm when closed APR_SHARELOCK support locking across process/machines </pre> </td></tr> <tr><td class="paramname">perms</td><td>Permissions to apply to if created </td></tr> <tr><td class="paramname">p</td><td>The pool to use when creating the sdbm </td></tr> </table> </dd> </dl> <dl class="section remark"><dt>Remarks</dt><dd>The sdbm name is not a true file name, as sdbm appends suffixes for seperate data and index files. </dd></dl> </div> </div> <a id="gabad67008f83fd219173acc5abdd0b42d"></a> <h2 class="memtitle"><span class="permalink"><a href="#gabad67008f83fd219173acc5abdd0b42d">◆ </a></span>apr_sdbm_rdonly()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int apr_sdbm_rdonly </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Returns true if the sdbm database opened for read-only access </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database to test </td></tr> </table> </dd> </dl> </div> </div> <a id="gac12993b882c50afa0777945ea4a88572"></a> <h2 class="memtitle"><span class="permalink"><a href="#gac12993b882c50afa0777945ea4a88572">◆ </a></span>apr_sdbm_store()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_store </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> </td> <td class="paramname"><em>key</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="structapr__sdbm__datum__t.html">apr_sdbm_datum_t</a> </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>opt</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Store an sdbm record value by key </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database </td></tr> <tr><td class="paramname">key</td><td>The key datum to store this record by </td></tr> <tr><td class="paramname">value</td><td>The value datum to store in this record </td></tr> <tr><td class="paramname">opt</td><td>The method used to store the record <pre> APR_SDBM_INSERT return an error if the record exists APR_SDBM_REPLACE overwrite any existing record for key </pre> </td></tr> </table> </dd> </dl> </div> </div> <a id="gab96a7e08ddac3cb6bff97a822b68de14"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab96a7e08ddac3cb6bff97a822b68de14">◆ </a></span>apr_sdbm_unlock()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_status_t apr_sdbm_unlock </td> <td>(</td> <td class="paramtype"><a class="el" href="structapr__sdbm__t.html">apr_sdbm_t</a> * </td> <td class="paramname"><em>db</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Release an sdbm lock previously aquired by apr_sdbm_lock </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">db</td><td>The database to unlock </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>