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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
<?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 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()</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>
Note that lockers are not free-threaded; lockers can not be used by
more than one thread at the same time.
</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="idp8067120"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp8044984"></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="idp8072368"></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="idp8023104"></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>
|