#include <db_cxx.h> int Dbc::close(void);
The Dbc::close() method discards the cursor.
It is possible for the Dbc::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 the Dbc::close() method has been called, regardless of its return value,
you can not use the cursor handle again.
It is not required to close the cursor explicitly before closing the database handle or the transaction handle that owns this cursor because, closing a database handle or a transaction handle closes those open cursors.
However, it is recommended that you always close all cursor handles immediately after their use to promote concurrency and to release resources such as page locks.
The Dbc::close()
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::close()
method may fail and throw a DbException
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
A transactional database environment operation was selected to resolve a deadlock.
DbDeadlockException is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, DB_LOCK_DEADLOCK is returned.
A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time.
DbLockNotGrantedException is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, DB_LOCK_NOTGRANTED is returned.