<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="Up" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of exceptions" rel=Appendix href="index_exceptions.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Dbm" rel="Chapter" href="Dbm.html"><title>Dbm</title> </head> <body> <div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> </div> <h1>Module <a href="type_Dbm.html">Dbm</a></h1> <pre><span class="keyword">module</span> Dbm: <code class="code">sig</code> <a href="Dbm.html">..</a> <code class="code">end</code></pre><div class="info module top"> Interface to the NDBM database.<br> </div> <hr width="100%"> <pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre> <div class="info "> The type of file descriptors opened on NDBM databases.<br> </div> <pre><code><span id="TYPEopen_flag"><span class="keyword">type</span> <code class="type"></code>open_flag</span> = </code></pre><table class="typetable"> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTopen_flag.Dbm_rdonly"><span class="constructor">Dbm_rdonly</span></span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTopen_flag.Dbm_wronly"><span class="constructor">Dbm_wronly</span></span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTopen_flag.Dbm_rdwr"><span class="constructor">Dbm_rdwr</span></span></code></td> </tr> <tr> <td align="left" valign="top" > <code><span class="keyword">|</span></code></td> <td align="left" valign="top" > <code><span id="TYPEELTopen_flag.Dbm_create"><span class="constructor">Dbm_create</span></span></code></td> <td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Flags for opening a database (see <a href="Dbm.html#VALopendbm"><code class="code">Dbm.opendbm</code></a>).</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td> </tr></table> <pre><span id="EXCEPTIONDbm_error"><span class="keyword">exception</span> Dbm_error</span> <span class="keyword">of</span> <code class="type">string</code></pre> <div class="info "> Raised by the following functions when an error is encountered.<br> </div> <pre><span id="VALopendbm"><span class="keyword">val</span> opendbm</span> : <code class="type">string -> <a href="Dbm.html#TYPEopen_flag">open_flag</a> list -> int -> <a href="Dbm.html#TYPEt">t</a></code></pre><div class="info "> Open a descriptor on an NDBM database. The first argument is the name of the database (without the <code class="code">.dir</code> and <code class="code">.pag</code> suffixes). The second argument is a list of flags: <code class="code">Dbm_rdonly</code> opens the database for reading only, <code class="code">Dbm_wronly</code> for writing only, <code class="code">Dbm_rdwr</code> for reading and writing; <code class="code">Dbm_create</code> causes the database to be created if it does not already exist. The third argument is the permissions to give to the database files, if the database is created.<br> </div> <pre><span id="VALclose"><span class="keyword">val</span> close</span> : <code class="type"><a href="Dbm.html#TYPEt">t</a> -> unit</code></pre><div class="info "> Close the given descriptor.<br> </div> <pre><span id="VALfind"><span class="keyword">val</span> find</span> : <code class="type"><a href="Dbm.html#TYPEt">t</a> -> string -> string</code></pre><div class="info "> <code class="code">find db key</code> returns the data associated with the given <code class="code">key</code> in the database opened for the descriptor <code class="code">db</code>. Raise <code class="code">Not_found</code> if the <code class="code">key</code> has no associated data.<br> </div> <pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="Dbm.html#TYPEt">t</a> -> string -> string -> unit</code></pre><div class="info "> <code class="code">add db key data</code> inserts the pair (<code class="code">key</code>, <code class="code">data</code>) in the database <code class="code">db</code>. If the database already contains data associated with <code class="code">key</code>, raise <code class="code">Dbm_error "Entry already exists"</code>.<br> </div> <pre><span id="VALreplace"><span class="keyword">val</span> replace</span> : <code class="type"><a href="Dbm.html#TYPEt">t</a> -> string -> string -> unit</code></pre><div class="info "> <code class="code">replace db key data</code> inserts the pair (<code class="code">key</code>, <code class="code">data</code>) in the database <code class="code">db</code>. If the database already contains data associated with <code class="code">key</code>, that data is discarded and silently replaced by the new <code class="code">data</code>.<br> </div> <pre><span id="VALremove"><span class="keyword">val</span> remove</span> : <code class="type"><a href="Dbm.html#TYPEt">t</a> -> string -> unit</code></pre><div class="info "> <code class="code">remove db key data</code> removes the data associated with <code class="code">key</code> in <code class="code">db</code>. If <code class="code">key</code> has no associated data, raise <code class="code">Dbm_error "dbm_delete"</code>.<br> </div> <pre><span id="VALfirstkey"><span class="keyword">val</span> firstkey</span> : <code class="type"><a href="Dbm.html#TYPEt">t</a> -> string</code></pre><div class="info "> See <a href="Dbm.html#VALnextkey"><code class="code">Dbm.nextkey</code></a>.<br> </div> <pre><span id="VALnextkey"><span class="keyword">val</span> nextkey</span> : <code class="type"><a href="Dbm.html#TYPEt">t</a> -> string</code></pre><div class="info "> Enumerate all keys in the given database, in an unspecified order. <code class="code">firstkey db</code> returns the first key, and repeated calls to <code class="code">nextkey db</code> return the remaining keys. <code class="code">Not_found</code> is raised when all keys have been enumerated.<br> </div> <pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">(string -> string -> 'a) -> <a href="Dbm.html#TYPEt">t</a> -> unit</code></pre><div class="info "> <code class="code">iter f db</code> applies <code class="code">f</code> to each (<code class="code">key</code>, <code class="code">data</code>) pair in the database <code class="code">db</code>. <code class="code">f</code> receives <code class="code">key</code> as first argument and <code class="code">data</code> as second argument.<br> </div> </body></html>
