1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>DbEnv::lock_id_free()</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> 10 <link rel="up" href="lock.html" title="Chapter 7. The DbLock Handle" /> 11 <link rel="prev" href="lockid.html" title="DbEnv::lock_id()" /> 12 <link rel="next" href="lockput.html" title="DbEnv::lock_put()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbEnv::lock_id_free()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="lockid.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 7. 23 The DbLock Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="lockput.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="lockid_free"></a>DbEnv::lock_id_free()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbEnv::lock_id_free(u_int32_t id);</pre> 42 <p> 43 The <code class="methodname">DbEnv::lock_id_free()</code> method frees a locker ID allocated by the 44 <a class="xref" href="lockid.html" title="DbEnv::lock_id()">DbEnv::lock_id()</a> method. 45 </p> 46 <p> 47 The <code class="methodname">DbEnv::lock_id_free()</code> <span> 48 49 <span> 50 method either returns a non-zero error value or throws an 51 exception that encapsulates a non-zero error value on 52 failure, and returns 0 on success. 53 </span> 54 </span> 55 </p> 56 <div class="sect2" lang="en" xml:lang="en"> 57 <div class="titlepage"> 58 <div> 59 <div> 60 <h3 class="title"><a id="id1681509"></a>Parameters</h3> 61 </div> 62 </div> 63 </div> 64 <div class="sect3" lang="en" xml:lang="en"> 65 <div class="titlepage"> 66 <div> 67 <div> 68 <h4 class="title"><a id="id1681773"></a>id</h4> 69 </div> 70 </div> 71 </div> 72 <p> 73 The <span class="bold"><strong>id</strong></span> parameter is the locker id to 74 be freed. 75 </p> 76 </div> 77 </div> 78 <div class="sect2" lang="en" xml:lang="en"> 79 <div class="titlepage"> 80 <div> 81 <div> 82 <h3 class="title"><a id="id1682016"></a>Errors</h3> 83 </div> 84 </div> 85 </div> 86 <p> 87 The <code class="methodname">DbEnv::lock_id_free()</code> <span> 88 89 <span> 90 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> 91 exception, encapsulating one of the following non-zero errors, or return one 92 of the following non-zero errors: 93 </span> 94 </span> 95 </p> 96 <div class="sect3" lang="en" xml:lang="en"> 97 <div class="titlepage"> 98 <div> 99 <div> 100 <h4 class="title"><a id="id1681786"></a>EINVAL</h4> 101 </div> 102 </div> 103 </div> 104 <p> 105 If the locker ID is invalid or locks are still held by this locker ID; 106 or if an invalid flag value or parameter was specified. 107 </p> 108 </div> 109 </div> 110 <div class="sect2" lang="en" xml:lang="en"> 111 <div class="titlepage"> 112 <div> 113 <div> 114 <h3 class="title"><a id="id1681564"></a>Class</h3> 115 </div> 116 </div> 117 </div> 118 <p> 119 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, 120 <a class="link" href="lock.html" title="Chapter 7. The DbLock Handle">DbLock</a> 121 </p> 122 </div> 123 <div class="sect2" lang="en" xml:lang="en"> 124 <div class="titlepage"> 125 <div> 126 <div> 127 <h3 class="title"><a id="id1681898"></a>See Also</h3> 128 </div> 129 </div> 130 </div> 131 <p> 132 <a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a> 133 </p> 134 </div> 135 </div> 136 <div class="navfooter"> 137 <hr /> 138 <table width="100%" summary="Navigation footer"> 139 <tr> 140 <td width="40%" align="left"><a accesskey="p" href="lockid.html">Prev</a> </td> 141 <td width="20%" align="center"> 142 <a accesskey="u" href="lock.html">Up</a> 143 </td> 144 <td width="40%" align="right"> <a accesskey="n" href="lockput.html">Next</a></td> 145 </tr> 146 <tr> 147 <td width="40%" align="left" valign="top">DbEnv::lock_id() </td> 148 <td width="20%" align="center"> 149 <a accesskey="h" href="index.html">Home</a> 150 </td> 151 <td width="40%" align="right" valign="top"> DbEnv::lock_put()</td> 152 </tr> 153 </table> 154 </div> 155 </body> 156</html> 157