summaryrefslogtreecommitdiff
path: root/db/docs/api_cxx/lock_id.html
blob: 537f249259282cd9474342ce809b75c3ded7e483 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<!--$Id: lock_id.so,v 10.33 2004/08/13 03:38:57 bostic Exp $-->
<!--Copyright 1997-2004 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::lock_id</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<h3>DbEnv::lock_id</h3>
</td>
<td align=right>
<a href="../api_cxx/api_index.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db_cxx.h&gt;
<p>
int
DbEnv::lock_id(u_int32_t *idp);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DbEnv::lock_id</h3>
<p>The DbEnv::lock_id method copies a locker ID, which is guaranteed to be
unique in the specified lock table, into the memory location to which
<b>idp</b> refers.</p>
<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
the Berkeley DB library when it is no longer needed.</p>
<p>The DbEnv::lock_id 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.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>idp</b><dd>The <b>idp</b> parameter references memory into which
 the allocated locker ID is copied.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a>
<h3>See Also</h3>
<a href="../api_cxx/lock_list.html">Locking Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>