<!--$Id: mutex_lock.so,v 10.2 2007/09/21 20:06:03 bostic Exp $--> <!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DbEnv::mutex_lock</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> <b>DbEnv::mutex_lock</b> </td> <td align=right> <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></td> </tr></table> <hr size=1 noshade> <tt> <b><pre> #include <db_cxx.h> <p> int DbEnv::mutex_lock(db_mutex_t mutex); </pre></b> <hr size=1 noshade> <b>Description: DbEnv::mutex_lock</b> <p>The DbEnv::mutex_lock method locks the mutex allocated by <a href="../api_cxx/mutex_alloc.html">DbEnv::mutex_alloc</a>. The thread of control calling DbEnv::mutex_lock will block until the lock is available.</p> <p>The DbEnv::mutex_lock method may not be called before the <a href="../api_cxx/env_open.html">DbEnv::open</a> method is called.</p> <p>The DbEnv::mutex_lock 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> <b>Parameters</b> <br> <b>mutex</b><ul compact><li>The <b>mutex</b> parameter is a mutex previously allocated by <a href="../api_cxx/mutex_alloc.html">DbEnv::mutex_alloc</a>.</ul> <br> <br><b>Errors</b> <p>The DbEnv::mutex_lock method may fail and throw <a href="../api_cxx/except_class.html">DbException</a>, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:</p> <br> <b>EINVAL</b><ul compact><li>An invalid flag value or parameter was specified.</ul> <br> <hr size=1 noshade> <br><b>Class</b> <a href="../api_cxx/env_class.html">DbEnv</a> <br><b>See Also</b> <a href="../api_cxx/env_list.html">Database Environments and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <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> </td></tr></table> <p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> </body> </html>