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_cache_max()</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="memp.html" title="Chapter 9. The DbMpoolFile Handle" /> 11 <link rel="prev" href="dbget_mpf.html" title="Db::get_mpf()" /> 12 <link rel="next" href="envget_cachesize.html" title="DbEnv::get_cachesize()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbEnv::get_cache_max()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="dbget_mpf.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 9. 23 The DbMpoolFile Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="envget_cachesize.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="envget_cache_max"></a>DbEnv::get_cache_max()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbEnv::get_cache_max(u_int32_t *gbytesp, u_int32_t *bytesp);</pre> 42 <p> 43 The <code class="methodname">DbEnv::get_cache_max()</code> method returns the maximum size of the 44 cache as set using the 45 <a class="xref" href="envset_cache_max.html" title="DbEnv::set_cache_max()">DbEnv::set_cache_max()</a> 46 method. 47 </p> 48 <p> 49 The <code class="methodname">DbEnv::get_cache_max()</code> method may be called at any time during 50 the life of the application. 51 </p> 52 <p> 53 The <code class="methodname">DbEnv::get_cache_max()</code> <span> 54 55 <span> 56 method either returns a non-zero error value or throws an 57 exception that encapsulates a non-zero error value on 58 failure, and returns 0 on success. 59 </span> 60 </span> 61 </p> 62 <div class="sect2" lang="en" xml:lang="en"> 63 <div class="titlepage"> 64 <div> 65 <div> 66 <h3 class="title"><a id="id1689737"></a>Parameters</h3> 67 </div> 68 </div> 69 </div> 70 <div class="sect3" lang="en" xml:lang="en"> 71 <div class="titlepage"> 72 <div> 73 <div> 74 <h4 class="title"><a id="id1689825"></a>bytesp</h4> 75 </div> 76 </div> 77 </div> 78 <p> 79 The <span class="bold"><strong>bytesp</strong></span> parameter references 80 memory into which the additional bytes of memory in the cache is 81 copied. 82 </p> 83 </div> 84 <div class="sect3" lang="en" xml:lang="en"> 85 <div class="titlepage"> 86 <div> 87 <div> 88 <h4 class="title"><a id="id1689750"></a>gbytesp</h4> 89 </div> 90 </div> 91 </div> 92 <p> 93 The <span class="bold"><strong>gbytesp</strong></span> parameter references 94 memory into which the gigabytes of memory in the cache is copied. 95 </p> 96 </div> 97 </div> 98 <div class="sect2" lang="en" xml:lang="en"> 99 <div class="titlepage"> 100 <div> 101 <div> 102 <h3 class="title"><a id="id1689972"></a>Class</h3> 103 </div> 104 </div> 105 </div> 106 <p> 107 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> 108 </p> 109 </div> 110 <div class="sect2" lang="en" xml:lang="en"> 111 <div class="titlepage"> 112 <div> 113 <div> 114 <h3 class="title"><a id="id1689988"></a>See Also</h3> 115 </div> 116 </div> 117 </div> 118 <p> 119 <a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a>, 120 <a class="xref" href="envset_cache_max.html" title="DbEnv::set_cache_max()">DbEnv::set_cache_max()</a> 121 </p> 122 </div> 123 </div> 124 <div class="navfooter"> 125 <hr /> 126 <table width="100%" summary="Navigation footer"> 127 <tr> 128 <td width="40%" align="left"><a accesskey="p" href="dbget_mpf.html">Prev</a> </td> 129 <td width="20%" align="center"> 130 <a accesskey="u" href="memp.html">Up</a> 131 </td> 132 <td width="40%" align="right"> <a accesskey="n" href="envget_cachesize.html">Next</a></td> 133 </tr> 134 <tr> 135 <td width="40%" align="left" valign="top">Db::get_mpf() </td> 136 <td width="20%" align="center"> 137 <a accesskey="h" href="index.html">Home</a> 138 </td> 139 <td width="40%" align="right" valign="top"> DbEnv::get_cachesize()</td> 140 </tr> 141 </table> 142 </div> 143 </body> 144</html> 145