Berkeley DB: DbMpoolFile::set_clear_len
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++

# DbMpoolFile::set_clear_len |

`

###

    #include <db_cxx.h>

    int
    DbMpoolFile::set(u_int32_t len);

# Description

The DbMpoolFile::set_clear_len method sets the number of initial bytes in a page that should be set to nul when the page is created as a result of the DB_MPOOL_CREATE or DB_MPOOL_NEW flags being specified to DbMpoolFile::get. If no value is specified, or len is 0, the entire page is cleared.

The DbMpoolFile::set_clear_len 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 DbMpoolFile::set_clear_len 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 DbMpoolFile::set_clear_len 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, DbMpoolFile

# See Also

DbEnv::set_cachesize, DbEnv::set_mp_mmapsize, DbEnv::memp_fcreate, DbMpoolFile::close, DbMpoolFile::get, DbMpoolFile::open, DbMpoolFile::put, DbMpoolFile::set, DbMpoolFile::sync, DbEnv::memp_register, DbMpoolFile::set_clear_len, DbMpoolFile::set_fileid, DbMpoolFile::set_ftype, DbMpoolFile::set_lsn_offset, DbMpoolFile::set_pgcookie, DbEnv::memp_stat, DbEnv::memp_sync, and DbEnv::memp_trickle.`

Copyright Sleepycat Software