1<!--$Id: mutex_lock.so,v 10.2 2007/09/21 20:06:03 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: DB_ENV->mutex_lock</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>DB_ENV->mutex_lock</b> 14</td> 15<td align=right> 16<a href="/api_c/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.h> 23<p> 24int 25DB_ENV->mutex_lock(DB_ENV *dbenv, db_mutex_t mutex); 26</pre></b> 27<hr size=1 noshade> 28<b>Description: DB_ENV->mutex_lock</b> 29<p>The DB_ENV->mutex_lock method locks the mutex allocated by 30<a href="/api_c/mutex_alloc.html">DB_ENV->mutex_alloc</a>. The thread of control calling DB_ENV->mutex_lock 31will block until the lock is available.</p> 32<p>The DB_ENV->mutex_lock method may not be called before the <a href="/api_c/env_open.html">DB_ENV->open</a> method is called.</p> 33<p>The DB_ENV->mutex_lock method 34returns a non-zero error value on failure 35and 0 on success. 36</p> 37<b>Parameters</b> <br> 38 <b>mutex</b><ul compact><li>The <b>mutex</b> parameter is a mutex previously allocated by 39<a href="/api_c/mutex_alloc.html">DB_ENV->mutex_alloc</a>.</ul> 40<br> 41<br><b>Errors</b> 42<p>The DB_ENV->mutex_lock method 43may fail and return one of the following non-zero errors:</p> 44<br> 45<b>EINVAL</b><ul compact><li>An 46invalid flag value or parameter was specified.</ul> 47<br> 48<hr size=1 noshade> 49<br><b>Class</b> 50<a href="/api_c/env_class.html">DB_ENV</a> 51<br><b>See Also</b> 52<a href="/api_c/env_list.html">Database Environments and Related Methods</a> 53</tt> 54<table width="100%"><tr><td><br></td><td align=right> 55<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a><a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a> 56</td></tr></table> 57<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 58</body> 59</html> 60
