Dbc::del |
#include <db_cxx.h>int Dbc::del(u_int32_t flags);
The Dbc::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 Dbc::del method will return DB_KEYEMPTY 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.
The Dbc::del method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:
If a transactional database environment operation was selected to resolve a deadlock, the Dbc::del method will fail and either return DB_LOCK_DEADLOCK or throw a DbDeadlockException exception.
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 DB_LOCK_NOTGRANTED or throw a DbLockNotGrantedException exception.
Copyright (c) 1996-2003 Sleepycat Software, Inc. - All rights reserved.