Berkeley DB: Dbc::del
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btr ee,hash,hashing,transaction,transactions,locking,logging,access method,access me thods,java,C,C++

# Dbc::del

`

###

    #include <db_cxx.h>

    int
    Dbc::del(u_int32_t flags);

# Description

The Dbc::del method deletes the key/data pair currently referenced by the cursor.

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 reference an existing key will fail.

If the element has already been deleted, Dbc::del will return DB_KEYEMPTY.

If the cursor is not yet initialized, the Dbc::del method either returns EINVAL or throws an exception that encapsulates EINVAL.

Otherwise, the Dbc::del method either returns errno or throws an exception that encapsulates an errno on failure, and 0 on success.

# Errors

If a fatal error occurs in Berkeley DB, the Dbc::del method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, at which point all subsequent database calls will also fail in the same way. Methods marked as returning errno will, by default, throw an exception that encapsulates the error information. The default error behavior can be changed, see DbException.

The Dbc::del method may fail and throw an exception for any of the errors specified for the following Berkeley DB and C library functions: __account_page(3), dbenv->db_paniccall(3), fflush(3), fprintf(3), free(3), func(3), DbLockTab::get, DbLock::put, DbLockTab::vec, DbLog::put, malloc(3), memcpy(3), memmove(3), DbMpoolFile::get, DbMpoolFile::put, DbMpoolFile::set, memset(3), realloc(3), strerror(3), vfprintf(3), and vsnprintf(3).

In addition, the Dbc::del method may fail and throw an exception or return errno for the following conditions:

EAGAIN
  A lock was unavailable.

EINVAL
  An invalid flag value or parameter was specified.

# Class

Dbc

# See Also

Dbc::close, Dbc::del, Dbc::get and Dbc::put.`