1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<!--$Id: dbc_del.so,v 10.44 2004/08/13 03:38:56 bostic Exp $-->
<!--Copyright 1997-2005 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DBcursor->c_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>DBcursor->c_del</h3>
</td>
<td align=right>
<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></td>
</tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db.h>
<p>
int
DBcursor->c_del(DBC *DBcursor, u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DBcursor->c_del</h3>
<p>The DBcursor->c_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_c/db_associate.html">DB->associate</a> method, the <a href="../api_c/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 DBcursor->c_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 DBcursor->c_del method
returns a non-zero error value on failure
and 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 DBcursor->c_del method
may fail and return one of the following non-zero errors:</p>
<dl compact>
<dt>DB_LOCK_DEADLOCK<dd>A transactional database environment operation was selected to resolve
a deadlock.
<dt>DB_LOCK_NOTGRANTED<dd>A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable
to grant a lock in the allowed time.
</dl>
<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_c/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag was
specified to <a href="../api_c/env_open.html">DB_ENV->open</a>.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_c/dbc_class.html">DBC</a>
<h3>See Also</h3>
<a href="../api_c/dbc_list.html">Database Cursors and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<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>
</td></tr></table>
<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2005</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>
|
