DBcursor->del API Ref

#include <db.h>

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


Description: DBcursor->del

The DBcursor->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 DB->associate method, the DB->del 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->del method will return DB_KEYEMPTY if the element has already been deleted. Unless otherwise specified, the DBcursor->del method returns a non-zero error value on failure and 0 on success.

Parameters
flags

Errors

The DBcursor->del method may fail and return one of the following non-zero errors:


DB_LOCK_DEADLOCK DB_LOCK_NOTGRANTED

DB_REP_HANDLE_DEAD

DB_REP_LOCKOUT

DB_SECONDARY_BAD

EACCES

EINVAL

EPERM


Class DBC
See Also Database Cursors and Related Methods

APIRef

Copyright (c) 1996,2008 Oracle. All rights reserved.