docs/api_reference/CXX/mutexlock.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4   <head>
   5     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6     <title>DbEnv::mutex_lock()</title>
   7     <link rel="stylesheet" href="apiReference.css" type="text/css" />
   8     <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
   9     <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
  10     <link rel="up" href="mutex.html" title="Chapter 10.  Mutex Methods" />
  11     <link rel="prev" href="mutexget_tas_spins.html" title="DbEnv::mutex_get_tas_spins()" />
  12     <link rel="next" href="mutexset_align.html" title="DbEnv::mutex_set_align()" />
  13   </head>
  14   <body>
  15     <div xmlns="" class="navheader">
  16       <div class="libver">
  17         <p>Library Version 11.2.5.3</p>
  18       </div>
  19       <table width="100%" summary="Navigation header">
  20         <tr>
  21           <th colspan="3" align="center">DbEnv::mutex_lock()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="mutexget_tas_spins.html">Prev</a> </td>
  25           <th width="60%" align="center">Chapter 10.
  26                 Mutex Methods
  27         </th>
  28           <td width="20%" align="right"> <a accesskey="n" href="mutexset_align.html">Next</a></td>
  29         </tr>
  30       </table>
  31       <hr />
  32     </div>
  33     <div class="sect1" lang="en" xml:lang="en">
  34       <div class="titlepage">
  35         <div>
  36           <div>
  37             <h2 class="title" style="clear: both"><a id="mutexlock"></a>DbEnv::mutex_lock()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db_cxx.h&gt;
  42
  43 int
  44 DbEnv::mutex_lock(db_mutex_t mutex);</pre>
  45       <p>
  46         The <code class="methodname">DbEnv::mutex_lock()</code> method locks the mutex allocated by
  47         <a class="xref" href="mutexalloc.html" title="DbEnv::mutex_alloc()">DbEnv::mutex_alloc()</a>.  The
  48          thread of control calling <code class="methodname">DbEnv::mutex_lock()</code> will block until the
  49          lock is available.
  50     </p>
  51       <p>
  52          The <code class="methodname">DbEnv::mutex_lock()</code> <span>
  53
  54             <span>
  55                 method either returns a non-zero error value or throws an
  56                 exception that encapsulates a non-zero error value on
  57                 failure, and returns 0 on success.
  58             </span>
  59         </span>
  60     </p>
  61       <div class="sect2" lang="en" xml:lang="en">
  62         <div class="titlepage">
  63           <div>
  64             <div>
  65               <h3 class="title"><a id="idp3826072"></a>Parameters</h3>
  66             </div>
  67           </div>
  68         </div>
  69         <div class="sect3" lang="en" xml:lang="en">
  70           <div class="titlepage">
  71             <div>
  72               <div>
  73                 <h4 class="title"><a id="idp3825424"></a>mutex</h4>
  74               </div>
  75             </div>
  76           </div>
  77           <p>
  78                           The <span class="bold"><strong>mutex</strong></span> parameter is a mutex
  79                           previously allocated by <a class="xref" href="mutexalloc.html" title="DbEnv::mutex_alloc()">DbEnv::mutex_alloc()</a>.
  80                      </p>
  81         </div>
  82       </div>
  83       <div class="sect2" lang="en" xml:lang="en">
  84         <div class="titlepage">
  85           <div>
  86             <div>
  87               <h3 class="title"><a id="idp3820928"></a>Errors</h3>
  88             </div>
  89           </div>
  90         </div>
  91         <p>
  92                          The <code class="methodname">DbEnv::mutex_lock()</code> <span>
  93
  94             <span>
  95                 method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
  96                 exception, encapsulating one of the following non-zero errors, or return one
  97                 of the following non-zero errors:
  98             </span>
  99         </span>
 100                     </p>
 101         <div class="sect3" lang="en" xml:lang="en">
 102           <div class="titlepage">
 103             <div>
 104               <div>
 105                 <h4 class="title"><a id="idp3834064"></a>EINVAL</h4>
 106               </div>
 107             </div>
 108           </div>
 109           <p>
 110                 An invalid flag value or parameter was specified.
 111             </p>
 112         </div>
 113       </div>
 114       <div class="sect2" lang="en" xml:lang="en">
 115         <div class="titlepage">
 116           <div>
 117             <div>
 118               <h3 class="title"><a id="idp3832768"></a>Class</h3>
 119             </div>
 120           </div>
 121         </div>
 122         <p>
 123                         <a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>
 124             </p>
 125       </div>
 126       <div class="sect2" lang="en" xml:lang="en">
 127         <div class="titlepage">
 128           <div>
 129             <div>
 130               <h3 class="title"><a id="idp3835392"></a>See Also</h3>
 131             </div>
 132           </div>
 133         </div>
 134         <p>
 135                      <a class="xref" href="mutex.html#mutexlist" title="Mutex Methods">Mutex Methods</a>
 136                 </p>
 137       </div>
 138     </div>
 139     <div class="navfooter">
 140       <hr />
 141       <table width="100%" summary="Navigation footer">
 142         <tr>
 143           <td width="40%" align="left"><a accesskey="p" href="mutexget_tas_spins.html">Prev</a> </td>
 144           <td width="20%" align="center">
 145             <a accesskey="u" href="mutex.html">Up</a>
 146           </td>
 147           <td width="40%" align="right"> <a accesskey="n" href="mutexset_align.html">Next</a></td>
 148         </tr>
 149         <tr>
 150           <td width="40%" align="left" valign="top">DbEnv::mutex_get_tas_spins() </td>
 151           <td width="20%" align="center">
 152             <a accesskey="h" href="index.html">Home</a>
 153           </td>
 154           <td width="40%" align="right" valign="top"> DbEnv::mutex_set_align()</td>
 155         </tr>
 156       </table>
 157     </div>
 158   </body>
 159 </html>