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: DB_SEQUENCE-&gt;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>DB_SEQUENCE-&gt;remove</b>
14</td>
15<td align=right>
16<a href="../api_c/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 &lt;db.h&gt;
23<p>
24int
25DB_SEQUENCE-&gt;remove(DB_SEQUENCE *seq, DB_TXN *txnid, u_int32_t flags);
26</pre></b>
27<hr size=1 noshade>
28<b>Description: DB_SEQUENCE-&gt;remove</b>
29<p>The DB_SEQUENCE-&gt;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_c/seq_class.html">DB_SEQUENCE</a> handle may not be accessed again after DB_SEQUENCE-&gt;remove is
33called, regardless of its return.</p>
34<p>The DB_SEQUENCE-&gt;remove method
35returns a non-zero error value on failure
36and 0 on success.
37</p>
38<b>Parameters</b> <br>
39 <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
40or more of the following values:
41<br>
42<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>
43argument is NULL but the operation occurs to a transactional database),
44do not synchronously flush the log when the transaction commits.</ul>
45<br></ul>
46 <b>txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the
47<b>txnid</b> parameter is a transaction handle returned from
48<a href="../api_c/txn_begin.html">DB_ENV-&gt;txn_begin</a>; if the operation is part of a Berkeley DB Concurrent Data Store group, the
49<b>txnid</b> parameter is a handle returned from
50<a href="../api_c/env_cdsgroup_begin.html">DB_ENV-&gt;cdsgroup_begin</a>; otherwise NULL.
51If no transaction handle is
52specified, but the
53operation occurs in a transactional
54database,
55the operation will be implicitly transaction protected.
56</ul>
57<br>
58<br><b>Errors</b>
59<p>The DB_SEQUENCE-&gt;remove method
60may fail and return one of the following non-zero errors:</p>
61<br>
62<b>EINVAL</b><ul compact><li>An
63invalid flag value or parameter was specified.</ul>
64<br>
65<hr size=1 noshade>
66<br><b>Class</b>
67<a href="../api_c/seq_class.html">DB_SEQUENCE</a>
68<br><b>See Also</b>
69<a href="../api_c/seq_list.html">Sequences and Related Methods</a>
70</tt>
71<table width="100%"><tr><td><br></td><td align=right>
72<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>
73</td></tr></table>
74<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
75</body>
76</html>
77