greg/libdb
1
0
Fork 0
mirror of https://github.com/berkeleydb/libdb.git synced 2024-11-17 01:26:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
libdb/docs/api_reference/C/mutexlock.html

156 lines
5.6 KiB
HTML
Raw Normal View History

Release 5.2.28 on 6/10/2011
2011-09-13 17:44:24 +00:00
<?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>DB_ENV-&gt;mutex_lock()</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="mutex.html" title="Chapter 9.  Mutex Methods" />
<link rel="prev" href="mutexget_tas_spins.html" title="DB_ENV-&gt;mutex_get_tas_spins()" />
<link rel="next" href="mutexset_align.html" title="DB_ENV-&gt;mutex_set_align()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
Release 5.3.21 5/11/2012
2012-11-14 21:35:20 +00:00
<p>Library Version 11.2.5.3</p>
Release 5.2.28 on 6/10/2011
2011-09-13 17:44:24 +00:00
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_ENV-&gt;mutex_lock()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mutexget_tas_spins.html">Prev</a> </td>
<th width="60%" align="center">Chapter 9. 
Mutex Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="mutexset_align.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="mutexlock"></a>DB_ENV-&gt;mutex_lock()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_ENV-&gt;mutex_lock(DB_ENV *dbenv, db_mutex_t mutex); </pre>
<p>
The <code class="methodname">DB_ENV-&gt;mutex_lock()</code> method locks the mutex allocated by
<a class="xref" href="mutexalloc.html" title="DB_ENV-&gt;mutex_alloc()">DB_ENV-&gt;mutex_alloc()</a>. The
thread of control calling <code class="methodname">DB_ENV-&gt;mutex_lock()</code> will block until the
lock is available.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;mutex_lock()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
Release 5.3.21 5/11/2012
2012-11-14 21:35:20 +00:00
<h3 class="title"><a id="idp61690184"></a>Parameters</h3>
Release 5.2.28 on 6/10/2011
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
Release 5.3.21 5/11/2012
2012-11-14 21:35:20 +00:00
<h4 class="title"><a id="idp61689536"></a>mutex</h4>
Release 5.2.28 on 6/10/2011
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
The <span class="bold"><strong>mutex</strong></span> parameter is a mutex
previously allocated by <a class="xref" href="mutexalloc.html" title="DB_ENV-&gt;mutex_alloc()">DB_ENV-&gt;mutex_alloc()</a>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
Release 5.3.21 5/11/2012
2012-11-14 21:35:20 +00:00
<h3 class="title"><a id="idp61676728"></a>Errors</h3>
Release 5.2.28 on 6/10/2011
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
The <code class="methodname">DB_ENV-&gt;mutex_lock()</code> <span>
<span>
method may fail and return one of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
Release 5.3.21 5/11/2012
2012-11-14 21:35:20 +00:00
<h4 class="title"><a id="idp61695352"></a>EINVAL</h4>
Release 5.2.28 on 6/10/2011
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
Release 5.3.21 5/11/2012
2012-11-14 21:35:20 +00:00
<h3 class="title"><a id="idp61694272"></a>Class</h3>
Release 5.2.28 on 6/10/2011
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
Release 5.3.21 5/11/2012
2012-11-14 21:35:20 +00:00
<h3 class="title"><a id="idp61689320"></a>See Also</h3>
Release 5.2.28 on 6/10/2011
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
<a class="xref" href="mutex.html#mutexlist" title="Mutex Methods">Mutex 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="mutexget_tas_spins.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="mutex.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="mutexset_align.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV-&gt;mutex_get_tas_spins() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV-&gt;mutex_set_align()</td>
</tr>
</table>
</div>
</body>
</html>
Reference in a new issue Copy permalink