Import BSDDB 4.7.25 (as of svn r89086)
This commit is contained in:
80
docs/api_cxx/seq_remove.html
Normal file
80
docs/api_cxx/seq_remove.html
Normal file
@@ -0,0 +1,80 @@
|
||||
<!--$Id: seq_remove.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
||||
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
||||
<!--See the file LICENSE for redistribution information.-->
|
||||
<html>
|
||||
<head>
|
||||
<title>Berkeley DB: DbSequence::remove</title>
|
||||
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
|
||||
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
|
||||
</head>
|
||||
<body bgcolor=white>
|
||||
<table width="100%"><tr valign=top>
|
||||
<td>
|
||||
<b>DbSequence::remove</b>
|
||||
</td>
|
||||
<td align=right>
|
||||
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
|
||||
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
|
||||
</tr></table>
|
||||
<hr size=1 noshade>
|
||||
<tt>
|
||||
<b><pre>
|
||||
#include <db_cxx.h>
|
||||
<p>
|
||||
int
|
||||
DbSequence::remove(u_int32_t flags);
|
||||
</pre></b>
|
||||
<hr size=1 noshade>
|
||||
<b>Description: DbSequence::remove</b>
|
||||
<p>The DbSequence::remove method removes the sequence from the database. This
|
||||
method should not be called if there are other open handles on this
|
||||
sequence.</p>
|
||||
<p>The <a href="../api_cxx/seq_class.html">DbSequence</a> handle may not be accessed again after DbSequence::remove is
|
||||
called, regardless of its return.</p>
|
||||
<p>The DbSequence::remove 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.
|
||||
</p>
|
||||
<b>Parameters</b> <br>
|
||||
<b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one
|
||||
or more of the following values:
|
||||
<br>
|
||||
<b><a name="DB_TXN_NOSYNC">DB_TXN_NOSYNC</a></b><ul compact><li>If the operation is implicitly transaction protected (the <b>txnid</b>
|
||||
argument is NULL but the operation occurs to a transactional database),
|
||||
do not synchronously flush the log when the transaction commits.</ul>
|
||||
<br></ul>
|
||||
<b>txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the
|
||||
<b>txnid</b> parameter is a transaction handle returned from
|
||||
<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>; if the operation is part of a Berkeley DB Concurrent Data Store group, the
|
||||
<b>txnid</b> parameter is a handle returned from
|
||||
<a href="../api_cxx/env_cdsgroup_begin.html">DbEnv::cdsgroup_begin</a>; otherwise NULL.
|
||||
If no transaction handle is
|
||||
specified, but the
|
||||
operation occurs in a transactional
|
||||
database,
|
||||
the operation will be implicitly transaction protected.
|
||||
</ul>
|
||||
<br>
|
||||
<br><b>Errors</b>
|
||||
<p>The DbSequence::remove method
|
||||
may fail and throw
|
||||
<a href="../api_cxx/except_class.html">DbException</a>,
|
||||
encapsulating one of the following non-zero errors, or return one of
|
||||
the following non-zero errors:</p>
|
||||
<br>
|
||||
<b>EINVAL</b><ul compact><li>An
|
||||
invalid flag value or parameter was specified.</ul>
|
||||
<br>
|
||||
<hr size=1 noshade>
|
||||
<br><b>Class</b>
|
||||
<a href="../api_cxx/seq_class.html">DbSequence</a>
|
||||
<br><b>See Also</b>
|
||||
<a href="../api_cxx/seq_list.html">Sequences and Related Methods</a>
|
||||
</tt>
|
||||
<table width="100%"><tr><td><br></td><td align=right>
|
||||
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
|
||||
</td></tr></table>
|
||||
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user