#include <db.h>

int
DBcursor->close(DBC *DBcursor);

Description: DBcursor->close

The DBcursor->close method discards the cursor.

It is possible for the DBcursor->close method to return DB_LOCK_DEADLOCK, signaling that any enclosing transaction should be aborted. If the application is already intending to abort the transaction, this error should be ignored, and the application should proceed.

After DBcursor->close has been called, regardless of its return, the cursor handle may not be used again.

The DBcursor->close method returns a non-zero error value on failure and 0 on success.

Errors

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

DB_LOCK_DEADLOCK

A transactional database environment operation was selected to resolve a deadlock.

DB_LOCK_NOTGRANTED

A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time.

EINVAL

If the cursor is already closed; or if an invalid flag value or parameter was specified.

Class

See Also