libdb/docs/api_reference/C/envget_cache_max.html
2012-11-14 16:35:20 -05:00

146 lines
5.5 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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_ENV-&gt;get_cache_max()</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="memp.html" title="Chapter 8.  The DB_MPOOLFILE Handle" />
<link rel="prev" href="dbget_mpf.html" title="DB-&gt;get_mpf()" />
<link rel="next" href="envget_cachesize.html" title="DB_ENV-&gt;get_cachesize()" />
</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_ENV-&gt;get_cache_max()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbget_mpf.html">Prev</a> </td>
<th width="60%" align="center">Chapter 8. 
The DB_MPOOLFILE Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="envget_cachesize.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="envget_cache_max"></a>DB_ENV-&gt;get_cache_max()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_ENV-&gt;get_cache_max(DB_ENV *dbenv, u_int32_t *gbytesp,
u_int32_t *bytesp); </pre>
<p>
The <code class="methodname">DB_ENV-&gt;get_cache_max()</code> method returns the maximum size of the
cache as set using the
<a class="xref" href="envset_cache_max.html" title="DB_ENV-&gt;set_cache_max()">DB_ENV-&gt;set_cache_max()</a>
method.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;get_cache_max()</code> method may be called at any time during
the life of the application.
</p>
<p>
The <code class="methodname">DB_ENV-&gt;get_cache_max()</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="idp61108224"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp61107576"></a>gbytesp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>gbytesp</strong></span> parameter references
memory into which the gigabytes of memory in the cache is copied.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp61063008"></a>bytesp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>bytesp</strong></span> parameter references
memory into which the additional bytes of memory in the cache is
copied.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61113000"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61114976"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>,
<a class="xref" href="envset_cache_max.html" title="DB_ENV-&gt;set_cache_max()">DB_ENV-&gt;set_cache_max()</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_mpf.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="memp.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="envget_cachesize.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB-&gt;get_mpf() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV-&gt;get_cachesize()</td>
</tr>
</table>
</div>
</body>
</html>