<!--$Id: db_truncate.so,v 1.13 2002/08/24 15:12:02 bostic Exp $--> <!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB->truncate</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> <h1>DB->truncate</h1> </td> <td align=right> <a href="../../db4-devel-4.1.25/api_c/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db.h> <p> int DB->truncate(DB *db, DB_TXN *txnid, u_int32_t *countp, u_int32_t flags); </pre></h3> <h1>Description</h1> <p>The DB->truncate interface empties the database, discarding all records it contains. The number of records discarded from the database is returned in <b>countp</b>. <p>If the operation is to be transaction-protected (other than by specifying the DB_AUTO_COMMIT flag), the <b>txnid</b> parameter is a transaction handle returned from <a href="../../db4-devel-4.1.25/api_c/txn_begin.html">DB_ENV->txn_begin</a>; otherwise, NULL. <p>The <b>flags</b> value must be set to 0 or the following value: <p><dl compact> <p><dt><a name="DB_AUTO_COMMIT">DB_AUTO_COMMIT</a><dd>Enclose the DB->truncate call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. </dl> <p>The DB->truncate method returns a non-zero error value on failure and 0 on success. <h1>Errors</h1> <p>The DB->truncate method may fail and return a non-zero error for the following conditions: <p><dl compact> <p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. </dl> <p>The DB->truncate method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DB->truncate method may fail and return <a href="../../db4-devel-4.1.25/ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../../db4-devel-4.1.25/api_c/db_class.html">DB</a> <h1>See Also</h1> <a href="../../db4-devel-4.1.25/api_c/db_list.html">Databases and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db4-devel-4.1.25/api_c/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> </body> </html>