1<!--$Id: lock_id.so,v 10.33 2004/08/13 03:38:57 bostic Exp $-->
2<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
3<!--See the file LICENSE for redistribution information.-->
4<html>
5<head>
6<title>Berkeley DB: DbEnv::lock_id</title>
7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
9</head>
10<body bgcolor=white>
11<table width="100%"><tr valign=top>
12<td>
13<b>DbEnv::lock_id</b>
14</td>
15<td align=right>
16<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
17<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
18</tr></table>
19<hr size=1 noshade>
20<tt>
21<b><pre>
22#include &lt;db_cxx.h&gt;
23<p>
24int
25DbEnv::lock_id(u_int32_t *idp);
26</pre></b>
27<hr size=1 noshade>
28<b>Description: DbEnv::lock_id</b>
29<p>The DbEnv::lock_id method copies a locker ID, which is guaranteed to be
30unique in the specified lock table, into the memory location to which
31<b>idp</b> refers.</p>
32<p>The <a href="../api_cxx/lock_id_free.html">DbEnv::lock_id_free</a> method should be called to return the locker ID to
33the Berkeley DB library when it is no longer needed.</p>
34<p>The DbEnv::lock_id method
35either returns a non-zero error value
36or throws an exception that encapsulates a non-zero error value on
37failure, and returns 0 on success.
38</p>
39<b>Parameters</b> <br>
40 <b>idp</b><ul compact><li>The <b>idp</b> parameter references memory into which
41 the allocated locker ID is copied.</ul> 
42<br>
43<hr size=1 noshade>
44<br><b>Class</b>
45<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a>
46<br><b>See Also</b>
47<a href="../api_cxx/lock_list.html">Locking Subsystem and Related Methods</a>
48</tt>
49<table width="100%"><tr><td><br></td><td align=right>
50<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
51</td></tr></table>
52<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
53</body>
54</html>
55