Imported Upstream version 5.3.21
[platform/upstream/libdb.git] / docs / api_reference / CXX / dbget_h_nelem.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>Db::get_h_nelem()</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="db.html" title="Chapter 2.  The Db Handle" />
11     <link rel="prev" href="dbget_h_ffactor.html" title="Db::get_h_ffactor()" />
12     <link rel="next" href="dbget_heapsize.html" title="Db::get_heapsize()" />
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">Db::get_h_nelem()</th>
22         </tr>
23         <tr>
24           <td width="20%" align="left"><a accesskey="p" href="dbget_h_ffactor.html">Prev</a> </td>
25           <th width="60%" align="center">Chapter 2. 
26                 The Db Handle
27         </th>
28           <td width="20%" align="right"> <a accesskey="n" href="dbget_heapsize.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="dbget_h_nelem"></a>Db::get_h_nelem()</h2>
38           </div>
39         </div>
40       </div>
41       <pre class="programlisting">#include &lt;db_cxx.h&gt;
42
43 int
44 Db::get_h_nelem(u_int32_t *h_nelemp);</pre>
45       <p>
46          The <code class="methodname">Db::get_h_nelem()</code> method returns the estimate of the final size
47          of the hash table as set by the 
48          <a class="xref" href="dbset_h_nelem.html" title="Db::set_h_nelem()">Db::set_h_nelem()</a>
49          method.
50     </p>
51       <p>
52          The <code class="methodname">Db::get_h_nelem()</code> method may be called at any time during the
53          life of the application.
54     </p>
55       <p>
56          The <code class="methodname">Db::get_h_nelem()</code> <span>
57             
58             <span>
59                 method either returns a non-zero error value or throws an
60                 exception that encapsulates a non-zero error value on
61                 failure, and returns 0 on success.
62             </span>
63         </span>
64     </p>
65       <div class="sect2" lang="en" xml:lang="en">
66         <div class="titlepage">
67           <div>
68             <div>
69               <h3 class="title"><a id="idm4271280"></a>Parameters</h3>
70             </div>
71           </div>
72         </div>
73         <div class="sect3" lang="en" xml:lang="en">
74           <div class="titlepage">
75             <div>
76               <div>
77                 <h4 class="title"><a id="idm4047680"></a>h_nelemp</h4>
78               </div>
79             </div>
80           </div>
81           <p>
82                           The <code class="methodname">Db::get_h_nelem()</code> method returns  the estimate of the final size
83                           of the hash table in <span class="bold"><strong>h_nelemp</strong></span>.
84                      </p>
85         </div>
86       </div>
87       <div class="sect2" lang="en" xml:lang="en">
88         <div class="titlepage">
89           <div>
90             <div>
91               <h3 class="title"><a id="idm556976"></a>Class</h3>
92             </div>
93           </div>
94         </div>
95         <p>
96                 <a class="link" href="db.html" title="Chapter 2.  The Db Handle">Db</a>  
97             </p>
98       </div>
99       <div class="sect2" lang="en" xml:lang="en">
100         <div class="titlepage">
101           <div>
102             <div>
103               <h3 class="title"><a id="idm705736"></a>See Also</h3>
104             </div>
105           </div>
106         </div>
107         <p>
108                      <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>, 
109                      <a class="xref" href="dbset_h_nelem.html" title="Db::set_h_nelem()">Db::set_h_nelem()</a>
110                 </p>
111       </div>
112     </div>
113     <div class="navfooter">
114       <hr />
115       <table width="100%" summary="Navigation footer">
116         <tr>
117           <td width="40%" align="left"><a accesskey="p" href="dbget_h_ffactor.html">Prev</a> </td>
118           <td width="20%" align="center">
119             <a accesskey="u" href="db.html">Up</a>
120           </td>
121           <td width="40%" align="right"> <a accesskey="n" href="dbget_heapsize.html">Next</a></td>
122         </tr>
123         <tr>
124           <td width="40%" align="left" valign="top">Db::get_h_ffactor() </td>
125           <td width="20%" align="center">
126             <a accesskey="h" href="index.html">Home</a>
127           </td>
128           <td width="40%" align="right" valign="top"> Db::get_heapsize()</td>
129         </tr>
130       </table>
131     </div>
132   </body>
133 </html>