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()</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="lockget.html" title="DbEnv::lock_get()" /> 12 <link rel="next" href="lockid_free.html" title="DbEnv::lock_id_free()" /> 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()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="lockget.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="lockid_free.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"></a>DbEnv::lock_id()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbEnv::lock_id(u_int32_t *idp);</pre> 42 <p> 43 The <code class="methodname">DbEnv::lock_id()</code> method copies a locker ID, which is guaranteed 44 to be unique in the environment's lock table, into the memory location to 45 which <span class="bold"><strong>idp</strong></span> refers. 46 </p> 47 <p> 48 The <a class="xref" href="lockid_free.html" title="DbEnv::lock_id_free()">DbEnv::lock_id_free()</a> 49 method should be called to return the locker ID to the Berkeley DB 50 library when it is no longer needed. 51 </p> 52 <p> 53 The <code class="methodname">DbEnv::lock_id()</code> <span> 54 55 <span> 56 method either returns a non-zero error value or throws an 57 exception that encapsulates a non-zero error value on 58 failure, and returns 0 on success. 59 </span> 60 </span> 61 </p> 62 <div class="sect2" lang="en" xml:lang="en"> 63 <div class="titlepage"> 64 <div> 65 <div> 66 <h3 class="title"><a id="id1681765"></a>Parameters</h3> 67 </div> 68 </div> 69 </div> 70 <div class="sect3" lang="en" xml:lang="en"> 71 <div class="titlepage"> 72 <div> 73 <div> 74 <h4 class="title"><a id="id1681769"></a>idp</h4> 75 </div> 76 </div> 77 </div> 78 <p> 79 The <span class="bold"><strong>idp</strong></span> parameter references memory 80 into which the allocated locker ID is copied. 81 </p> 82 </div> 83 </div> 84 <div class="sect2" lang="en" xml:lang="en"> 85 <div class="titlepage"> 86 <div> 87 <div> 88 <h3 class="title"><a id="id1681907"></a>Class</h3> 89 </div> 90 </div> 91 </div> 92 <p> 93 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, 94 <a class="link" href="lock.html" title="Chapter 7. The DbLock Handle">DbLock</a> 95 </p> 96 </div> 97 <div class="sect2" lang="en" xml:lang="en"> 98 <div class="titlepage"> 99 <div> 100 <div> 101 <h3 class="title"><a id="id1681758"></a>See Also</h3> 102 </div> 103 </div> 104 </div> 105 <p> 106 <a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a> 107 </p> 108 </div> 109 </div> 110 <div class="navfooter"> 111 <hr /> 112 <table width="100%" summary="Navigation footer"> 113 <tr> 114 <td width="40%" align="left"><a accesskey="p" href="lockget.html">Prev</a> </td> 115 <td width="20%" align="center"> 116 <a accesskey="u" href="lock.html">Up</a> 117 </td> 118 <td width="40%" align="right"> <a accesskey="n" href="lockid_free.html">Next</a></td> 119 </tr> 120 <tr> 121 <td width="40%" align="left" valign="top">DbEnv::lock_get() </td> 122 <td width="20%" align="center"> 123 <a accesskey="h" href="index.html">Home</a> 124 </td> 125 <td width="40%" align="right" valign="top"> DbEnv::lock_id_free()</td> 126 </tr> 127 </table> 128 </div> 129 </body> 130</html> 131