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

153 lines
6.3 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_MPOOLFILE-&gt;set_maxsize()</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="mempset_lsn_offset.html" title="DB_MPOOLFILE-&gt;set_lsn_offset()" />
<link rel="next" href="mempset_pgcookie.html" title="DB_MPOOLFILE-&gt;set_pgcookie()" />
</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_MPOOLFILE-&gt;set_maxsize()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="mempset_lsn_offset.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="mempset_pgcookie.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="mempset_maxsize"></a>DB_MPOOLFILE-&gt;set_maxsize()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_MPOOLFILE-&gt;set_maxsize(DB_MPOOLFILE *mpf,
u_int32_t gbytes, u_int32_t bytes); </pre>
<p>
Set the maximum size for the file to be <span class="bold"><strong>gbytes</strong></span> gigabytes plus <span class="bold"><strong>bytes</strong></span>. Attempts to allocate new pages in the
file after the limit has been reached will fail.
</p>
<p>
To set the maximum file size for a particular database, call the
<code class="methodname">DB_MPOOLFILE-&gt;set_maxsize()</code> method using the
<a class="link" href="memp.html" title="Chapter 8.  The DB_MPOOLFILE Handle">DB_MPOOLFILE</a> handle stored
in the <span class="bold"><strong>mpf</strong></span> field of the
<a class="link" href="db.html" title="Chapter 2.  The DB Handle">DB</a> handle. Attempts to insert
new items into the database after the limit has been reached may fail.
</p>
<p>
The <code class="methodname">DB_MPOOLFILE-&gt;set_maxsize()</code> method configures a file in the
cache, not only operations performed using the specified
<a class="link" href="memp.html" title="Chapter 8.  The DB_MPOOLFILE Handle">DB_MPOOLFILE</a> handle.
</p>
<p>
The <code class="methodname">DB_MPOOLFILE-&gt;set_maxsize()</code> method may be called at any time
during the life of the application.
</p>
<p>
The <code class="methodname">DB_MPOOLFILE-&gt;set_maxsize()</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="idp61593040"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp61592392"></a>bytes</h4>
</div>
</div>
</div>
<p>
The maximum size of the file is set to <span class="bold"><strong>gbytes</strong></span> gigabytes plus <span class="bold"><strong>bytes</strong></span>.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp61579040"></a>gbytes</h4>
</div>
</div>
</div>
<p>
The maximum size of the file is set to <span class="bold"><strong>gbytes</strong></span> gigabytes plus <span class="bold"><strong>bytes</strong></span>.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61583096"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>, <a class="link" href="memp.html" title="Chapter 8.  The DB_MPOOLFILE Handle">DB_MPOOLFILE</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61598040"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="memp.html#memplist" title="Memory Pools and Related Methods">Memory Pools and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="mempset_lsn_offset.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="mempset_pgcookie.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_MPOOLFILE-&gt;set_lsn_offset() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_MPOOLFILE-&gt;set_pgcookie()</td>
</tr>
</table>
</div>
</body>
</html>