docs/api_reference/CXX/envget_lk_tablesize.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::get_lk_tablesize()</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="lock.html" title="Chapter 7.  The DbLock Handle" />
  11     <link rel="prev" href="envget_lk_priority.html" title="DbEnv::get_lk_priority()" />
  12     <link rel="next" href="envset_lk_conflicts.html" title="DbEnv::set_lk_conflicts()" />
  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::get_lk_tablesize()</th>
  22         </tr>
  23         <tr>
  24           <td width="20%" align="left"><a accesskey="p" href="envget_lk_priority.html">Prev</a> </td>
  25           <th width="60%" align="center">Chapter 7.
  26                 The DbLock Handle
  27         </th>
  28           <td width="20%" align="right"> <a accesskey="n" href="envset_lk_conflicts.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="envget_lk_tablesize"></a>DbEnv::get_lk_tablesize()</h2>
  38           </div>
  39         </div>
  40       </div>
  41       <pre class="programlisting">#include &lt;db_cxx.h&gt;
  42
  43 int
  44 DbEnv::get_lk_tablesize(u_int32_t *tablesizep);</pre>
  45       <p>
  46         The <code class="methodname">DbEnv::get_lk_tablesize()</code> method
  47         returns the size of the lock object hash table in the Berkeley DB
  48         environment.  This value is set using the
  49         <a class="xref" href="envset_lk_tablesize.html" title="DbEnv::set_lk_tablesize()">DbEnv::set_lk_tablesize()</a>
  50         method.
  51      </p>
  52       <p>
  53          The <code class="methodname">DbEnv::get_lk_tablesize()</code> method may be
  54          called at any time during the life of the application.
  55      </p>
  56       <p>
  57          The <code class="methodname">DbEnv::get_lk_tablesize()</code>  <span>
  58
  59             <span>
  60                 method either returns a non-zero error value or throws an
  61                 exception that encapsulates a non-zero error value on
  62                 failure, and returns 0 on success.
  63             </span>
  64         </span>
  65      </p>
  66       <div class="sect2" lang="en" xml:lang="en">
  67         <div class="titlepage">
  68           <div>
  69             <div>
  70               <h3 class="title"><a id="idp2536328"></a>Parameters</h3>
  71             </div>
  72           </div>
  73         </div>
  74         <div class="sect3" lang="en" xml:lang="en">
  75           <div class="titlepage">
  76             <div>
  77               <div>
  78                 <h4 class="title"><a id="idp2535680"></a>tablesizep</h4>
  79               </div>
  80             </div>
  81           </div>
  82           <p>
  83                   The <span class="bold"><strong>tablesizep</strong></span> parameter
  84                   references memory into which is copied the size of the
  85                   lock object hash table configured for the Berkeley DB
  86                   environment.
  87              </p>
  88         </div>
  89       </div>
  90       <div class="sect2" lang="en" xml:lang="en">
  91         <div class="titlepage">
  92           <div>
  93             <div>
  94               <h3 class="title"><a id="idp2502712"></a>Class</h3>
  95             </div>
  96           </div>
  97         </div>
  98         <p>
  99             <a class="link" href="env.html" title="Chapter 5.  The DbEnv Handle">DbEnv</a>,
 100             <a class="link" href="lock.html" title="Chapter 7.  The DbLock Handle">DbLock</a>
 101         </p>
 102       </div>
 103       <div class="sect2" lang="en" xml:lang="en">
 104         <div class="titlepage">
 105           <div>
 106             <div>
 107               <h3 class="title"><a id="idp2500216"></a>See Also</h3>
 108             </div>
 109           </div>
 110         </div>
 111         <p>
 112              <a class="xref" href="lock.html#locklist" title="Locking Subsystem and Related Methods">Locking Subsystem and Related Methods</a>
 113         </p>
 114       </div>
 115     </div>
 116     <div class="navfooter">
 117       <hr />
 118       <table width="100%" summary="Navigation footer">
 119         <tr>
 120           <td width="40%" align="left"><a accesskey="p" href="envget_lk_priority.html">Prev</a> </td>
 121           <td width="20%" align="center">
 122             <a accesskey="u" href="lock.html">Up</a>
 123           </td>
 124           <td width="40%" align="right"> <a accesskey="n" href="envset_lk_conflicts.html">Next</a></td>
 125         </tr>
 126         <tr>
 127           <td width="40%" align="left" valign="top">DbEnv::get_lk_priority() </td>
 128           <td width="20%" align="center">
 129             <a accesskey="h" href="index.html">Home</a>
 130           </td>
 131           <td width="40%" align="right" valign="top"> DbEnv::set_lk_conflicts()</td>
 132         </tr>
 133       </table>
 134     </div>
 135   </body>
 136 </html>