1<!--$Id: lock_id_free.so,v 10.14 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_free</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_free</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 <db_cxx.h> 23<p> 24int 25DbEnv::lock_id_free(u_int32_t id); 26</pre></b> 27<hr size=1 noshade> 28<b>Description: DbEnv::lock_id_free</b> 29<p>The DbEnv::lock_id_free method frees a locker ID allocated by the 30<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a> method.</p> 31<p>The DbEnv::lock_id_free method 32either returns a non-zero error value 33or throws an exception that encapsulates a non-zero error value on 34failure, and returns 0 on success. 35</p> 36<b>Parameters</b> <br> 37 <b>id</b><ul compact><li>The <b>id</b> parameter is the locker id to be freed.</ul> 38<br> 39<br><b>Errors</b> 40<p>The DbEnv::lock_id_free method 41may fail and throw 42<a href="../api_cxx/except_class.html">DbException</a>, 43encapsulating one of the following non-zero errors, or return one of 44the following non-zero errors:</p> 45<br> 46<b>EINVAL</b><ul compact><li>If the locker ID is invalid or locks are still held by this locker ID; or if an 47invalid flag value or parameter was specified.</ul> 48<br> 49<hr size=1 noshade> 50<br><b>Class</b> 51<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> 52<br><b>See Also</b> 53<a href="../api_cxx/lock_list.html">Locking Subsystem and Related Methods</a> 54</tt> 55<table width="100%"><tr><td><br></td><td align=right> 56<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> 57</td></tr></table> 58<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 59</body> 60</html> 61