DbEnv::log_register

APIRef

#include <db_cxx.h>

int DbEnv::log_register(Db *dbp, const char *name);

Description

The DbEnv::log_register method registers a filename with the specified Berkeley DB environment's log manager. The log manager records all filename mappings at each checkpoint so that a recovery process can identify the file to which a record in the log refers.

The dbp argument should be a reference to the Db object being registered. The name argument should be a filename appropriate for opening the file in the environment during recovery.

The DbEnv::log_register 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.

Errors

The DbEnv::log_register method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
An invalid flag value or parameter was specified.

The DbEnv::log_register 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 DbEnv::log_register 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.

Class

DbEnv

See Also

DbEnv::set_lg_bsize, DbEnv::set_lg_dir, DbEnv::set_lg_max, DbEnv::set_lg_regionmax, DbEnv::log_archive, DbEnv::log_compare, DbEnv::log_file, DbEnv::log_flush, DbEnv::log_get, DbEnv::log_put, DbEnv::log_register, DbEnv::log_stat, and DbEnv::log_unregister.

APIRef

Copyright Sleepycat Software