<!--$Id: dbc_del.html,v 1.1.1.1 2003/02/15 04:55:51 zarzycki Exp $--> <!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: Dbc.del</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> </head> <body bgcolor=white> <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h1>Dbc.del</h1> </td> <td align=right> <a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> import com.sleepycat.db.*; <p> public int del(int flags) throws DbException; </pre></h3> <h1>Description</h1> <p>The Dbc.del method deletes the key/data pair to which the cursor refers. <p>When called on a cursor opened on a database that has been made into a secondary index using the <a href="../api_java/db_associate.html">Db.associate</a> method, the <a href="../api_java/db_del.html">Db.del</a> method deletes the key/data pair from the primary database and all secondary indices. <p>The <b>flags</b> parameter is currently unused, and must be set to 0. <p>The cursor position is unchanged after a delete, and subsequent calls to cursor functions expecting the cursor to refer to an existing key will fail. <p> If the element has already been deleted, the Dbc.del method will return Db.DB_KEYEMPTY. If the cursor is not yet initialized, the Dbc.del method throws an exception that encapsulates Db.EINVAL. Otherwise, the Dbc.del method throws an exception that encapsulates a non-zero error value on failure. <h1>Errors</h1> <p>The Dbc.del method may fail and throw an exception encapsulating a non-zero error for the following conditions: <p><dl compact> <p><dt>Db.DB_SECONDARY_BAD<dd>A secondary index references a nonexistent primary key. </dl> <p><dl compact> <p><dt>EACCES<dd>An attempt was made to modify a read-only database. </dl> <p><dl compact> <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. </dl> <p><dl compact> <p><dt>EPERM <dd>Write attempted on read-only cursor when the <a href="../api_java/env_open.html#DB_INIT_CDB">Db.DB_INIT_CDB</a> flag was specified to <a href="../api_java/env_open.html">DbEnv.open</a>. </dl> <p>If the operation was selected to resolve a deadlock, the Dbc.del method will fail and throw a <a href="../api_java/deadlock_class.html">DbDeadlockException</a> exception. <p>The Dbc.del method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the Dbc.del method may fail and throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_java/dbc_class.html">Dbc</a> <h1>See Also</h1> <a href="../api_java/dbc_list.html">Database Cursors and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> </body> </html>