Berkeley DB: log_register
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# log_register |

`

###

    #include <db.h>

    int
    log_register(DB_ENV *env,
    	DB *dbp, const char *name, int32_t *fidp);

# Description

The log_register function registers a file name with the log manager and copies a file identification number into the memory location referenced by fidp.

This file identification number should be used in all subsequent log messages that refer to operations on the file. The log manager records all file name to file identification number mappings at each checkpoint so that a recovery process can identify the file to which a record in the log refers.

The dbp parameter should be a reference to a DB structure.

The log_register function returns a non-zero error value on failure and 0 on success.

# Errors

If a fatal error occurs in Berkeley DB, the log_register function will fail and return DB_RUNRECOVERY, at which point all subsequent database calls will fail in the same way.

In addition, the log_register function may fail and return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

In addition, the log_register function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.

# See Also

DBENV->set_lg_bsize, DBENV->set_lg_max, log_archive, log_compare, log_file, log_flush, log_get, log_put, log_register, log_stat and log_unregister.`

Copyright Sleepycat Software