head 1.2; access; symbols RPM_4_2_1:1.1.1.5 RPM_4_2:1.1.1.5 RPM_4_1_1:1.1.1.5 RPM_4_1:1.1.1.4 RPM_4_0_5:1.1.1.3 RPM_4_0_4:1.1.1.2 RPM_4_0_3:1.1.1.1 RPM:1.1.1; locks; strict; comment @# @; 1.2 date 2008.01.02.09.52.52; author rse; state dead; branches; next 1.1; commitid z4cpSiAhOCXk5PLs; 1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches; next 1.1.1.2; 1.1.1.2 date 2002.01.08.00.30.08; author rse; state Exp; branches; next 1.1.1.3; 1.1.1.3 date 2003.01.18.13.48.55; author rse; state Exp; branches; next 1.1.1.4; 1.1.1.4 date 2001.12.06.00.07.57; author rse; state Exp; branches; next 1.1.1.5; 1.1.1.5 date 2003.01.18.14.04.56; author rse; state Exp; branches; next ; desc @@ 1.2 log @remove the ancient RPM 4.2.1 source tree copy @ text @ Berkeley DB: DBcursor->c_del

DBcursor->c_del

 APIRef 

#include <db.h>


int
DBcursor->c_del(DBC *cursor, u_int32_t flags);

Description

The DBcursor->c_del function 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 DB->associate function, the DB->del function deletes the key/data pair from the primary database and all secondary indices.

The flags parameter is currently unused, and must be set to 0.

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.

If the element has already been deleted, DBcursor->c_del will return DB_KEYEMPTY.

If the cursor is not yet initialized, the DBcursor->c_del function will return EINVAL.

Otherwise, the DBcursor->c_del function returns a non-zero error value on failure and 0 on success.

Errors

The DBcursor->c_del function may fail and return a non-zero error for the following conditions:

DB_LOCK_DEADLOCK
The operation was selected to resolve a deadlock.

DB_SECONDARY_BAD
A secondary index references a nonexistent primary key.

EACCES
An attempt was made to modify a read-only database.

EINVAL
An invalid flag value or parameter was specified.

EPERM
Write attempted on read-only cursor when the DB_INIT_CDB flag was specified to DB_ENV->open.

The DBcursor->c_del function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DBcursor->c_del function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

See Also

DBcursor->c_close, DBcursor->c_count, DBcursor->c_del, DBcursor->c_dup, DBcursor->c_get, DBcursor->c_pget, and DBcursor->c_put.

APIRef

Copyright Sleepycat Software @ 1.1 log @Initial revision @ text @d1 1 a1 1 @ 1.1.1.1 log @Import: RPM 4.0.3 @ text @@ 1.1.1.2 log @Import: RPM 4.0.4 @ text @d1 1 a1 1 @ 1.1.1.3 log @Import: RPM 4.0.5 @ text @d1 2 a2 2 a3 1 d28 1 a28 1

The DBcursor->c_del method deletes the key/data pair to which the cursor d31 1 a31 1 secondary index using the DB->associate method, the DB->del method d38 4 a41 4

If the element has already been deleted, the DBcursor->c_del method will return DB_KEYEMPTY. If the cursor is not yet initialized, the DBcursor->c_del method will return EINVAL. Otherwise, the DBcursor->c_del method returns a non-zero error value on failure and 0 on success. d43 1 a43 1

The DBcursor->c_del method may fail and return a non-zero error for the following conditions: d60 4 a63 6

The DBcursor->c_del method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DBcursor->c_del method may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

Class

DBC d65 8 a72 1 Database Cursors and Related Methods @ 1.1.1.4 log @Import: RPM 4.1 @ text @d1 2 a2 2 d4 1 d29 1 a29 1

The DBcursor->c_del function deletes the key/data pair to which the cursor d32 1 a32 1 secondary index using the DB->associate function, the DB->del function d39 4 a42 4

If the element has already been deleted, DBcursor->c_del will return DB_KEYEMPTY.

If the cursor is not yet initialized, the DBcursor->c_del function will return EINVAL.

Otherwise, the DBcursor->c_del function returns a non-zero error value on failure and 0 on success. d44 1 a44 1

The DBcursor->c_del function may fail and return a non-zero error for the following conditions: d61 6 a66 4

The DBcursor->c_del function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DBcursor->c_del function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way. d68 1 a68 8 DBcursor->c_close, DBcursor->c_count, DBcursor->c_del, DBcursor->c_dup, DBcursor->c_get, DBcursor->c_pget, and DBcursor->c_put. @ 1.1.1.5 log @Import: RPM 4.1.1 @ text @d1 2 a2 2 a3 1 d28 1 a28 1

The DBcursor->c_del method deletes the key/data pair to which the cursor d31 1 a31 1 secondary index using the DB->associate method, the DB->del method d38 4 a41 4

If the element has already been deleted, the DBcursor->c_del method will return DB_KEYEMPTY. If the cursor is not yet initialized, the DBcursor->c_del method will return EINVAL. Otherwise, the DBcursor->c_del method returns a non-zero error value on failure and 0 on success. d43 1 a43 1

The DBcursor->c_del method may fail and return a non-zero error for the following conditions: d60 4 a63 6

The DBcursor->c_del method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DBcursor->c_del method may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

Class

DBC d65 8 a72 1 Database Cursors and Related Methods @