Edit File - File Manager

Edit File: dbc_del.html

<html>
<head>
<title>Berkeley DB: DBcursor-&gt;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>
DBcursor-&gt;del
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db.h&gt;

int
DBcursor-&gt;del(DBC *DBcursor, u_int32_t flags);
</pre>
<hr size=1 noshade>
Description: DBcursor-&gt;del
The DBcursor-&gt;del method deletes the key/data pair to which the cursor
refers.
When called on a cursor opened on a database that has been made into a
secondary index using the <a href="../../db4-devel-4.7.25/api_c/db_associate.html">DB-&gt;associate</a> method, the <a href="../../db4-devel-4.7.25/api_c/db_del.html">DB-&gt;del</a> method
deletes the key/data pair from the primary database and all secondary
indices.
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.
The DBcursor-&gt;del method will return <a href="../../db4-devel-4.7.25/ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a> if the element has already been deleted.
Unless otherwise specified, the DBcursor-&gt;del method
returns a non-zero error value on failure
and 0 on success.

Parameters 
 flags<ul compact><li>The flags parameter is currently unused, and must be set to 0.</ul>
 
 Errors
The DBcursor-&gt;del method
may fail and return one of the following non-zero errors:
 
DB_LOCK_DEADLOCK<ul compact><li>A transactional database environment operation was selected to resolve
a deadlock.</ul>
DB_LOCK_NOTGRANTED<ul compact><li>A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable
to grant a lock in the allowed time.</ul>
 
 
DB_REP_HANDLE_DEAD<ul compact><li>The database handle has been invalidated because a replication election
unrolled a committed transaction.</ul>
 
 
DB_REP_LOCKOUT<ul compact><li>The operation was blocked by client/master synchronization.</ul>
 
 
DB_SECONDARY_BAD<ul compact><li>A secondary index references a nonexistent primary key.</ul>
 
 
EACCES<ul compact><li>An attempt was made to modify a read-only database.</ul>
 
 
EINVAL<ul compact><li>If the cursor has not been initialized; or if an
invalid flag value or parameter was specified.</ul>
 
 
EPERM <ul compact><li>Write attempted on read-only cursor when the <a href="../../db4-devel-4.7.25/api_c/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag was
specified to <a href="../../db4-devel-4.7.25/api_c/env_open.html">DB_ENV-&gt;open</a>.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_c/dbc_class.html">DBC</a>
 See Also
<a href="../../db4-devel-4.7.25/api_c/dbc_list.html">Database Cursors and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_c/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager