Db::truncate |
#include <db_cxx.h>int Db::truncate(DbTxn *txnid, u_int32_t *countp, u_int32_t flags);
The Db::truncate interface empties the database, discarding all records it contains. The number of records discarded from the database is returned in countp.
If the operation is to be transaction-protected, the txnid parameter is a transaction handle returned from DbEnv::txn_begin; otherwise, NULL.
The flags parameter is currently unused, and must be set to 0.
The Db::truncate 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 Db::truncate method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the Db::truncate method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.