mirror of
https://github.com/berkeleydb/libdb.git
synced 2024-11-17 01:26:25 +00:00
198 lines
7.5 KiB
HTML
198 lines
7.5 KiB
HTML
|
<?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</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="seq.html" title="Chapter 12. The DbSequence Handle" />
|
|||
|
|
<link rel="next" href="seqclose.html" title="DbSequence::close()" />
|
|||
|
|
</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</th>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width="20%" align="left"><a accesskey="p" href="seq.html">Prev</a> </td>
|
|||
|
|
<th width="60%" align="center">Chapter 12.
|
|||
|
|
The DbSequence Handle
|
|||
|
|
</th>
|
|||
|
|
<td width="20%" align="right"> <a accesskey="n" href="seqclose.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="seqcreate"></a>DbSequence</h2>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<pre class="programlisting">#include <db_cxx.h>
|
|||
|
|
|
|||
|
|
class DbSequence {
|
|||
|
|
public:
|
|||
|
|
DbSequence(Db *db, u_int32_t flags);
|
|||
|
|
~DbSequence();
|
|||
|
|
|
|||
|
|
DB_SEQUENCE *DbSequence::get_DB();
|
|||
|
|
const DB *DbSequence::get_const_DB() const;
|
|||
|
|
static DbSequence *DbSequence::get_DbSequence(DB *db);
|
|||
|
|
static const DbSequence
|
|||
|
|
*DbSequence::get_const_DbSequence(const DB *db);
|
|||
|
|
...
|
|||
|
|
}; </pre>
|
|||
|
|
<p>
|
|||
|
|
The <code class="classname">DbSequence</code> handle is the handle used to manipulate a sequence
|
|||
|
|
object. A sequence object is stored in a record in a database.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
|
|||
|
|
<code class="classname">DbSequence</code> handles are free-threaded if the
|
|||
|
|
<a class="link" href="seqopen.html#seqopen_DB_THREAD">DB_THREAD</a>
|
|||
|
|
flag is specified to the
|
|||
|
|
<a class="xref" href="seqopen.html" title="DbSequence::open()">DbSequence::open()</a>
|
|||
|
|
method when the sequence is opened. Once the
|
|||
|
|
<a class="xref" href="seqclose.html" title="DbSequence::close()">DbSequence::close()</a> or
|
|||
|
|
<a class="xref" href="seqremove.html" title="DbSequence::remove()">DbSequence::remove()</a>
|
|||
|
|
methods are called, the handle can not be accessed again, regardless
|
|||
|
|
of the method's return.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
Each handle opened on a sequence may maintain a separate cache of values which are
|
|||
|
|
returned to the application using the <a class="xref" href="seqget.html" title="DbSequence::get()">DbSequence::get()</a>
|
|||
|
|
method either singly or in groups
|
|||
|
|
depending on its <span class="bold"><strong>delta</strong></span> parameter.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
Calling the <a class="xref" href="seqclose.html" title="DbSequence::close()">DbSequence::close()</a>
|
|||
|
|
or <a class="xref" href="seqremove.html" title="DbSequence::remove()">DbSequence::remove()</a>
|
|||
|
|
methods discards this handle.
|
|||
|
|
</p>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="id3667272"></a>Parameters</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3667275"></a>db</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
The <span class="bold"><strong>db</strong></span> parameter is an open database
|
|||
|
|
handle which holds the persistent data for the sequence. The database
|
|||
|
|
may be of any type, but must not have been configured to support
|
|||
|
|
duplicate data items.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3667085"></a>flags</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
The <span class="bold"><strong>flags</strong></span> parameter is
|
|||
|
|
currently unused, and must be set to 0.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="id3666905"></a>Errors</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
The <code class="methodname">db_sequence_create</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="id3667383"></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="id3667368"></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="id3667302"></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="seq.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="seqclose.html">Next</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width="40%" align="left" valign="top">Chapter 12.
|
|||
|
|
The DbSequence Handle
|
|||
|
|
</td>
|
|||
|
|
<td width="20%" align="center">
|
|||
|
|
<a accesskey="h" href="index.html">Home</a>
|
|||
|
|
</td>
|
|||
|
|
<td width="40%" align="right" valign="top"> DbSequence::close()</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|