libdb/docs/api_reference/CXX/seqset_cachesize.html
2011-09-13 13:44:24 -04:00

160 lines
5.7 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>DbSequence::set_cachesize()</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="seq.html" title="Chapter 12.  The DbSequence Handle" />
<link rel="prev" href="seqremove.html" title="DbSequence::remove()" />
<link rel="next" href="seqset_flags.html" title="DbSequence::set_flags()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DbSequence::set_cachesize()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="seqremove.html">Prev</a> </td>
<th width="60%" align="center">Chapter 12. 
The DbSequence Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="seqset_flags.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="seqset_cachesize"></a>DbSequence::set_cachesize()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
DbSequence::set_cachesize(int32_t size); </pre>
<p>
Configure the number of elements cached by a sequence handle.
</p>
<p>
The <code class="methodname">DbSequence::set_cachesize()</code> method may not be called after the
<a class="xref" href="seqopen.html" title="DbSequence::open()">DbSequence::open()</a>
method is called.
</p>
<p>
The <code class="methodname">DbSequence::set_cachesize()</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="id3668404"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3669010"></a>size</h4>
</div>
</div>
</div>
<p>
The number of elements in the cache.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3668603"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbSequence::set_cachesize()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="id3668482"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3668772"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="seq.html" title="Chapter 12.  The DbSequence Handle">DbSequence</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="id3669115"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="seq.html#seqlist" title="Sequences and Related Methods">Sequences 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="seqremove.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="seq.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="seqset_flags.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbSequence::remove() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbSequence::set_flags()</td>
</tr>
</table>
</div>
</body>
</html>