docs/api_reference/CXX/mutexget_max.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_get_max()</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_init.html" title="DbEnv::mutex_get_init()" />
  12     <link rel="next" href="mutexget_tas_spins.html" title="DbEnv::mutex_get_tas_spins()" />
  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_get_max()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="mutexget_init.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="mutexget_tas_spins.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="mutexget_max"></a>DbEnv::mutex_get_max()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db_cxx.h&gt;
  42
  43 int
  44 DbEnv::mutex_get_max(u_int32_t *maxp); </pre>
  45       <p>
  46          The <code class="methodname">DbEnv::mutex_get_max()</code> method returns the total number of
  47          mutexes allocated. This method is deprecated.
  48     </p>
  49       <p>
  50          The <code class="methodname">DbEnv::mutex_get_max()</code> method may be called at any time during
  51          the life of the application.
  52     </p>
  53       <p>
  54          The <code class="methodname">DbEnv::mutex_get_max()</code> <span>
  55
  56             <span>
  57                 method either returns a non-zero error value or throws an
  58                 exception that encapsulates a non-zero error value on
  59                 failure, and returns 0 on success.
  60             </span>
  61         </span>
  62     </p>
  63       <div class="sect2" lang="en" xml:lang="en">
  64         <div class="titlepage">
  65           <div>
  66             <div>
  67               <h3 class="title"><a id="idp3811904"></a>Parameters</h3>
  68             </div>
  69           </div>
  70         </div>
  71         <div class="sect3" lang="en" xml:lang="en">
  72           <div class="titlepage">
  73             <div>
  74               <div>
  75                 <h4 class="title"><a id="idp3811256"></a>maxp</h4>
  76               </div>
  77             </div>
  78           </div>
  79           <p>
  80                           The <code class="methodname">DbEnv::mutex_get_max()</code> method returns  the total number of
  81                           mutexes allocated in <span class="bold"><strong>maxp</strong></span>.
  82                      </p>
  83         </div>
  84       </div>
  85       <div class="sect2" lang="en" xml:lang="en">
  86         <div class="titlepage">
  87           <div>
  88             <div>
  89               <h3 class="title"><a id="idp3807192"></a>Class</h3>
  90             </div>
  91           </div>
  92         </div>
  93         <p>
  94                 <a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>
  95             </p>
  96       </div>
  97       <div class="sect2" lang="en" xml:lang="en">
  98         <div class="titlepage">
  99           <div>
 100             <div>
 101               <h3 class="title"><a id="idp3805384"></a>See Also</h3>
 102             </div>
 103           </div>
 104         </div>
 105         <p>
 106                      <a class="xref" href="mutex.html#mutexlist" title="Mutex Methods">Mutex Methods</a>
 107                 </p>
 108       </div>
 109     </div>
 110     <div class="navfooter">
 111       <hr />
 112       <table width="100%" summary="Navigation footer">
 113         <tr>
 114           <td width="40%" align="left"><a accesskey="p" href="mutexget_init.html">Prev</a> </td>
 115           <td width="20%" align="center">
 116             <a accesskey="u" href="mutex.html">Up</a>
 117           </td>
 118           <td width="40%" align="right"> <a accesskey="n" href="mutexget_tas_spins.html">Next</a></td>
 119         </tr>
 120         <tr>
 121           <td width="40%" align="left" valign="top">DbEnv::mutex_get_init() </td>
 122           <td width="20%" align="center">
 123             <a accesskey="h" href="index.html">Home</a>
 124           </td>
 125           <td width="40%" align="right" valign="top"> DbEnv::mutex_get_tas_spins()</td>
 126         </tr>
 127       </table>
 128     </div>
 129   </body>
 130 </html>