<!--$Id: txn_checkpoint.so,v 10.47 2003/11/20 14:55:40 bostic Exp $--> <!--Copyright 1997-2003 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DbEnv::txn_checkpoint</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> </head> <body bgcolor=white> <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3>DbEnv::txn_checkpoint</h3> </td> <td align=right> <a href="../../db42-devel-4.2.52/api_cxx/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a> <a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db_cxx.h> <p> int DbEnv::txn_checkpoint(u_int32_t kbyte, u_int32_t min, u_int32_t flags) const; </pre></h3> <hr size=1 noshade> <h3>Description: DbEnv::txn_checkpoint</h3> <p>The DbEnv::txn_checkpoint method flushes the underlying memory pool, writes a checkpoint record to the log, and then flushes the log.</p> <p>The DbEnv::txn_checkpoint 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. </p> <h3>Parameters</h3> <p><dl compact> <p><dt><b>flags</b><dd> The <b>flags</b> parameter must be set to 0 or the following value: <p><dl compact> <p><dt><a name="DB_FORCE">DB_FORCE</a><dd>Force a checkpoint record, even if there has been no activity since the last checkpoint. </dl> <p><dt><b>kbyte</b><dd> If the <b>kbyte</b> parameter is non-zero, a checkpoint will be done if more than <b>kbyte</b> kilobytes of log data have been written since the last checkpoint. <p><dt><b>min</b><dd> If the <b>min</b> parameter is non-zero, a checkpoint will be done if more than <b>min</b> minutes have passed since the last checkpoint. </dl> <h3>Errors</h3> <p>The DbEnv::txn_checkpoint method may fail and throw <a href="../../db42-devel-4.2.52/api_cxx/except_class.html">DbException</a>, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:</p> <p><dl compact> <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../../db42-devel-4.2.52/api_cxx/env_class.html">DbEnv</a>, <a href="../../db42-devel-4.2.52/api_cxx/txn_class.html">DbTxn</a> <h3>See Also</h3> <a href="../../db42-devel-4.2.52/api_cxx/txn_list.html">Transaction Subsystem and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db42-devel-4.2.52/api_cxx/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a><a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1><a href="../../db42-devel-4.2.52/sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html>