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

`

###

    #include <db_cxx.h>

    int
    DbMpoolFile::close(u_int32_t flags);

# Description

The DbMpoolFile::close method closes the source file indicated by the DbMpoolFile object. Calling DbMpoolFile::close does not imply a call to DbMpoolFile::sync; that is, no pages are written to the source file as as a result of calling DbMpoolFile::close.

If the DbMpoolFile was temporary, any underlying files created for this DbMpoolFile will be removed.

The flags parameter is currently unused, and must be set to 0.

After DbMpoolFile::close has been called, regardless of its return, the DbMpoolFile handle may not be accessed again.

The DbMpoolFile::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.

# Errors

The DbMpoolFile::close 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::close method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

DbEnv, DbMpoolFile

# See Also

Memory Pools and Related Methods`

Copyright Sleepycat Software