1<!--$Id: seq_remove.so,v 1.6 2004/12/16 19:13:04 bostic Exp $--> 2<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 3<!--See the file LICENSE for redistribution information.--> 4<html> 5<head> 6<title>Berkeley DB: DbSequence::remove</title> 7<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 8<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 9</head> 10<body bgcolor=white> 11<table width="100%"><tr valign=top> 12<td> 13<b>DbSequence::remove</b> 14</td> 15<td align=right> 16<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a> 17<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> 18</tr></table> 19<hr size=1 noshade> 20<tt> 21<b><pre> 22#include <db_cxx.h> 23<p> 24int 25DbSequence::remove(u_int32_t flags); 26</pre></b> 27<hr size=1 noshade> 28<b>Description: DbSequence::remove</b> 29<p>The DbSequence::remove method removes the sequence from the database. This 30method should not be called if there are other open handles on this 31sequence.</p> 32<p>The <a href="../api_cxx/seq_class.html">DbSequence</a> handle may not be accessed again after DbSequence::remove is 33called, regardless of its return.</p> 34<p>The DbSequence::remove method 35either returns a non-zero error value 36or throws an exception that encapsulates a non-zero error value on 37failure, and returns 0 on success. 38</p> 39<b>Parameters</b> <br> 40 <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 41or more of the following values: 42<br> 43<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> 44argument is NULL but the operation occurs to a transactional database), 45do not synchronously flush the log when the transaction commits.</ul> 46<br></ul> 47 <b>txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the 48<b>txnid</b> parameter is a transaction handle returned from 49<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 50<b>txnid</b> parameter is a handle returned from 51<a href="../api_cxx/env_cdsgroup_begin.html">DbEnv::cdsgroup_begin</a>; otherwise NULL. 52If no transaction handle is 53specified, but the 54operation occurs in a transactional 55database, 56the operation will be implicitly transaction protected. 57</ul> 58<br> 59<br><b>Errors</b> 60<p>The DbSequence::remove method 61may fail and throw 62<a href="../api_cxx/except_class.html">DbException</a>, 63encapsulating one of the following non-zero errors, or return one of 64the following non-zero errors:</p> 65<br> 66<b>EINVAL</b><ul compact><li>An 67invalid flag value or parameter was specified.</ul> 68<br> 69<hr size=1 noshade> 70<br><b>Class</b> 71<a href="../api_cxx/seq_class.html">DbSequence</a> 72<br><b>See Also</b> 73<a href="../api_cxx/seq_list.html">Sequences and Related Methods</a> 74</tt> 75<table width="100%"><tr><td><br></td><td align=right> 76<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> 77</td></tr></table> 78<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 79</body> 80</html> 81