<?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>Db::get_heapsize()</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="db.html" title="Chapter 2. The Db Handle" /> <link rel="prev" href="dbget_h_nelem.html" title="Db::get_h_nelem()" /> <link rel="next" href="dbget_heap_regionsize.html" title="Db::get_heap_regionsize()" /> </head> <body> <div xmlns="" class="navheader"> <div class="libver"> <p>Library Version 11.2.5.3</p> </div> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center">Db::get_heapsize()</th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="dbget_h_nelem.html">Prev</a> </td> <th width="60%" align="center">Chapter 2. The Db Handle </th> <td width="20%" align="right"> <a accesskey="n" href="dbget_heap_regionsize.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="dbget_heapsize"></a>Db::get_heapsize()</h2> </div> </div> </div> <pre class="programlisting">#include <db_cxx.h> int Db::get_heapsize(u_int32_t *gbytesp, u_int32_t *bytesp);</pre> <p> Used when the underlying database is configured to use the Heap access method. This method returns the maximum size of the database's heap file. This value may be set using the <a class="xref" href="dbset_heapsize.html" title="Db::set_heapsize()">Db::set_heapsize()</a> method. </p> <p> The <code class="methodname">Db::get_heapsize()</code> method may be called at any time during the life of the application. </p> <p> The <code class="methodname">Db::get_heapsize()</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="idm5070792"></a>Parameters</h3> </div> </div> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idm7360416"></a>gbytesp</h4> </div> </div> </div> <p> The <span class="bold"><strong>gbytesp</strong></span> parameter references memory into which is copied the maximum number of gigabytes in the heap. </p> </div> <div class="sect3" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h4 class="title"><a id="idm3489248"></a>bytesp</h4> </div> </div> </div> <p> The <span class="bold"><strong>bytesp</strong></span> parameter references memory into which is copied the additional bytes in the heap. </p> </div> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idm5985320"></a>Class</h3> </div> </div> </div> <p> <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <div> <div> <h3 class="title"><a id="idm1157200"></a>See Also</h3> </div> </div> </div> <p> <a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>, <a class="xref" href="dbset_heapsize.html" title="Db::set_heapsize()">Db::set_heapsize()</a> </p> </div> </div> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"><a accesskey="p" href="dbget_h_nelem.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="db.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="dbget_heap_regionsize.html">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top">Db::get_h_nelem() </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> Db::get_heap_regionsize()</td> </tr> </table> </div> </body> </html>