diff options
| author | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
|---|---|---|
| committer | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
| commit | 3ef782d3745ea8f25a3151561a3cfb882190210e (patch) | |
| tree | 86b9c2f5fde051dd0bced99b3fc9f5a3ba08db69 /docs/api_reference/C/dbget_heapsize.html | |
| download | berkeleydb-3ef782d3745ea8f25a3151561a3cfb882190210e.tar.gz | |
Tarball conversion
Diffstat (limited to 'docs/api_reference/C/dbget_heapsize.html')
| -rw-r--r-- | docs/api_reference/C/dbget_heapsize.html | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/docs/api_reference/C/dbget_heapsize.html b/docs/api_reference/C/dbget_heapsize.html new file mode 100644 index 00000000..4d8b40b1 --- /dev/null +++ b/docs/api_reference/C/dbget_heapsize.html @@ -0,0 +1,147 @@ +<?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.h> + +int +DB->get_heapsize(DB *db, 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 returns a non-zero error value on failure and 0 on success. + </span> + + </span> + </p> + <div class="sect2" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h3 class="title"><a id="idp57665144"></a>Parameters</h3> + </div> + </div> + </div> + <div class="sect3" lang="en" xml:lang="en"> + <div class="titlepage"> + <div> + <div> + <h4 class="title"><a id="idp57664496"></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="idp57650776"></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="idp57648456"></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="idp57654064"></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> |