94 lines
4.1 KiB
HTML
94 lines
4.1 KiB
HTML
<!--$Id: dbc_del.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
|
<!--Copyright (c) 1997,2008 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>
|
|
<b>Dbc::del</b>
|
|
</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>
|
|
<b><pre>
|
|
#include <db_cxx.h>
|
|
<p>
|
|
int
|
|
Dbc::del(u_int32_t flags);
|
|
</pre></b>
|
|
<hr size=1 noshade>
|
|
<b>Description: Dbc::del</b>
|
|
<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>
|
|
<b>Parameters</b> <br>
|
|
<b>flags</b><ul compact><li>The <b>flags</b> parameter is currently unused, and must be set to 0.</ul>
|
|
<br>
|
|
<br><b>Errors</b>
|
|
<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>
|
|
<br>
|
|
<b>DB_REP_HANDLE_DEAD</b><ul compact><li>The database handle has been invalidated because a replication election
|
|
unrolled a committed transaction.</ul>
|
|
<br>
|
|
<br>
|
|
<b>DB_REP_LOCKOUT</b><ul compact><li>The operation was blocked by client/master synchronization.</ul>
|
|
<br>
|
|
<br>
|
|
<b>DB_SECONDARY_BAD</b><ul compact><li>A secondary index references a nonexistent primary key.</ul>
|
|
<br>
|
|
<br>
|
|
<b>EACCES</b><ul compact><li>An attempt was made to modify a read-only database.</ul>
|
|
<br>
|
|
<br>
|
|
<b>EINVAL</b><ul compact><li>If the cursor has not been initialized; or if an
|
|
invalid flag value or parameter was specified.</ul>
|
|
<br>
|
|
<br>
|
|
<b>EPERM </b><ul compact><li>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>.</ul>
|
|
<br>
|
|
<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>
|
|
<br><b>Class</b>
|
|
<a href="../api_cxx/dbc_class.html">Dbc</a>
|
|
<br><b>See Also</b>
|
|
<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,2008 Oracle. All rights reserved.</font>
|
|
</body>
|
|
</html>
|