libdb/docs/api_reference/CXX/mutexunlock.html
2011-09-13 13:44:24 -04:00

159 lines
5.7 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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::mutex_unlock()</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 10.  Mutex Methods" />
<link rel="prev" href="mutexstat_print.html" title="DbEnv::mutex_stat_print()" />
<link rel="next" href="rep.html" title="Chapter 11.  Replication Methods" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbEnv::mutex_unlock()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mutexstat_print.html">Prev</a> </td>
<th width="60%" align="center">Chapter 10. 
Mutex Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="rep.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="mutexunlock"></a>DbEnv::mutex_unlock()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
DbEnv::mutex_unlock(db_mutex_t mutex);</pre>
<p>
The <code class="methodname">DbEnv::mutex_unlock()</code> method unlocks the mutex locked by
<a class="xref" href="mutexlock.html" title="DbEnv::mutex_lock()">DbEnv::mutex_lock()</a>.
</p>
<p>
The <code class="methodname">DbEnv::mutex_unlock()</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="id3654623"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3654895"></a>mutex</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>mutex</strong></span> parameter is a mutex
previously locked by <a class="xref" href="mutexlock.html" title="DbEnv::mutex_lock()">DbEnv::mutex_lock()</a>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3654302"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::mutex_unlock()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3654629"></a>EINVAL</h4>
</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>
<h3 class="title"><a id="id3654882"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3654397"></a>See Also</h3>
</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="mutexstat_print.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="rep.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::mutex_stat_print() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Chapter 11. 
Replication Methods
</td>
</tr>
</table>
</div>
</body>
</html>