<!--$Id: dbc_del.so,v 10.47 2006/10/24 13:26:50 bostic Exp $--> <!--Copyright (c) 1997,2007 Oracle. 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,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>Dbc::del</h3> </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> <h3><pre> #include <db_cxx.h> <p> int Dbc::del(u_int32_t flags); </pre></h3> <hr size=1 noshade> <h3>Description: Dbc::del</h3> <p>The Dbc::del method deletes the key/data pair to which the cursor refers.</p> <p>When called on a cursor opened on a database that has been made into a secondary index using the <a href="../api_cxx/db_associate.html">Db::associate</a> method, the <a href="../api_cxx/db_del.html">Db::del</a> method deletes the key/data pair from the primary database and all secondary indices.</p> <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> <p>The Dbc::del method will return <a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a> if the element has already been deleted. Unless otherwise specified, the Dbc::del 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> <h3>Parameters</h3> <dl compact> <dt><b>flags</b><dd>The <b>flags</b> parameter is currently unused, and must be set to 0. </dl> <h3>Errors</h3> <p>The Dbc::del 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> <dl compact> <dt>DB_REP_HANDLE_DEAD<dd>The database handle has been invalidated because a replication election unrolled a committed transaction. <dt>DB_REP_LOCKOUT<dd>The operation was blocked by client/master synchronization. </dl> <dl compact> <dt>DB_SECONDARY_BAD<dd>A secondary index references a nonexistent primary key. </dl> <dl compact> <dt>EACCES<dd>An attempt was made to modify a read-only database. </dl> <dl compact> <dt>EINVAL<dd>If the cursor has not been initialized; or if an invalid flag value or parameter was specified. </dl> <dl compact> <dt>EPERM <dd>Write attempted on read-only cursor when the <a href="../api_cxx/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag was specified to <a href="../api_cxx/env_open.html">DbEnv::open</a>. </dl> <p>If a transactional database environment operation was selected to resolve a deadlock, the Dbc::del method will fail and either return <a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a> or throw a <a href="../api_cxx/deadlock_class.html">DbDeadlockException</a> exception.</p> <p>If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time, the Dbc::del method will fail and either return <a href="../ref/program/errorret.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a> or throw a <a href="../api_cxx/lockng_class.html">DbLockNotGrantedException</a> exception.</p> <hr size=1 noshade> <h3>Class</h3> <a href="../api_cxx/dbc_class.html">Dbc</a> <h3>See Also</h3> <a href="../api_cxx/dbc_list.html">Database Cursors 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,2007 Oracle. All rights reserved.</font> </body> </html>