1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
|
<!--$Id: seq_remove.so,v 1.6 2004/12/16 19:13:04 bostic Exp $-->
<!--Copyright 1997-2005 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_SEQUENCE->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>
<h3>DB_SEQUENCE->remove</h3>
</td>
<td align=right>
<a href="../api_c/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>
<h3><pre>
#include <db.h>
<p>
int
DB_SEQUENCE->remove(DB_SEQUENCE *seq, DB_TXN *txnid, u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB_SEQUENCE->remove</h3>
<p>The DB_SEQUENCE->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_c/seq_class.html">DB_SEQUENCE</a> handle may not be accessed again after DB_SEQUENCE->remove is
called, regardless of its return.</p>
<p>The DB_SEQUENCE->remove method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>flags</b><dd>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:
<dl compact>
<dt><a name="DB_TXN_NOSYNC">DB_TXN_NOSYNC</a><dd>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.
</dl>
<dt><b>txnid</b><dd>If the operation is part of an application-specified
transaction, the <b>txnid</b> parameter is a transaction handle
returned from <a href="../api_c/txn_begin.html">DB_ENV->txn_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.
</dl>
<h3>Errors</h3>
<p>The DB_SEQUENCE->remove method
may fail and return one of the following non-zero errors:</p>
<dl compact>
<dt>EINVAL<dd>An
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_c/seq_class.html">DB_SEQUENCE</a>
<h3>See Also</h3>
<a href="../api_c/seq_list.html">Sequences and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/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><a href="../sleepycat/legal.html">Copyright (c) 1996-2005</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>
|