<?xml version="1.0" encoding="UTF-8" standalone="no"?> <!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/html; charset=UTF-8" /> <title>DbEnv::lock_id_free()</title> <link rel="stylesheet" href="apiReference.css" type="text/css" /> <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> <link rel="up" href="lock.html" title="Chapter 7. The DbLock Handle" /> <link rel="prev" href="lockid.html" title="DbEnv::lock_id()" /> <link rel="next" href="lockput.html" title="DbEnv::lock_put()" /> </head> <body> <div xmlns="" class="navheader"> <div class="libver"> <p>Library Version 11.2.5.3</p> </div> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">DbEnv::lock_id_free()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="lockid.html">Prev</a> </td> <th width="60%" align="center">Chapter 7. The DbLock Handle </th> <td width="20%" align="right"> <a accesskey="n" href="lockput.html">Next</a></td> </tr> </table> <hr /> </div> <div class="sect1" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h2 class="title" style="clear: both"><a id="lockid_free"></a>DbEnv::lock_id_free()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int DbEnv::lock_id_free(u_int32_t id);</pre> <p> The <code class="methodname">DbEnv::lock_id_free()</code> method frees a locker ID allocated by the <a class="xref" href="lockid.html" title="DbEnv::lock_id()">DbEnv::lock_id()</a> method. </p> <p> The <code class="methodname">DbEnv::lock_id_free()</code> <span> <span> method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success. </span> </span> </p> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp2727688"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp2727040"></a>id</h4> </div> </div> </div> <p> The <span class="bold"><strong>id</strong></span> parameter is the locker id to be freed. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp2665280"></a>Errors</h3> </div> </div> </div> <p> The <code class="methodname">DbEnv::lock_id_free()</code> <span> <span> method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a> exception, encapsulating one of the following non-zero errors, or return one of the following non-zero errors: </span> </span> </p> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idp2735168"></a>EINVAL</h4> </div> </div> </div> <p> If the locker ID is invalid or locks are still held by this locker ID; or if an invalid flag value or parameter was specified. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp2734088"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, <a class="link" href="lock.html" title="Chapter 7. The DbLock Handle">DbLock</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idp2736496"></a>See Also</h3> </div> </div> </div> <p> <a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="lockid.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="lock.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="lockput.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DbEnv::lock_id() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DbEnv::lock_put()</td> </tr> </table> </div> </body> </html>