<?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()</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="lockget.html" title="DbEnv::lock_get()" /> <link rel="next" href="lockid_free.html" title="DbEnv::lock_id_free()" /> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">DbEnv::lock_id()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="lockget.html">Prev</a> </td> <th width="60%" align="center">Chapter 7. The DbLock Handle </th> <td width="20%" align="right"> <a accesskey="n" href="lockid_free.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"></a>DbEnv::lock_id()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int DbEnv::lock_id(u_int32_t *idp);</pre> <p> The <code class="methodname">DbEnv::lock_id()</code> method copies a locker ID, which is guaranteed to be unique in the environment's lock table, into the memory location to which <span class="bold"><strong>idp</strong></span> refers. </p> <p> The <a class="xref" href="lockid_free.html" title="DbEnv::lock_id_free()">DbEnv::lock_id_free()</a> method should be called to return the locker ID to the Berkeley DB library when it is no longer needed. </p> <p> The <code class="methodname">DbEnv::lock_id()</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="id1681765"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="id1681769"></a>idp</h4> </div> </div> </div> <p> The <span class="bold"><strong>idp</strong></span> parameter references memory into which the allocated locker ID is copied. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="id1681907"></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="id1681758"></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="lockget.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="lockid_free.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">DbEnv::lock_get() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> DbEnv::lock_id_free()</td> </tr> </table> </div> </body> </html>