<!--$Id: txn_discard.so,v 10.16 2004/08/13 03:39:03 bostic Exp $--> <!--Copyright (c) 1997,2007 Oracle. All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DB_TXN->discard</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> </head> <body bgcolor=white> <table width="100%"><tr valign=top> <td> <h3>DB_TXN->discard</h3> </td> <td align=right> <a href="../../db46-devel-4.6.21/api_c/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a> <a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a></td> </tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db.h> <p> int DB_TXN->discard(DB_TXN *tid, u_int32_t flags); </pre></h3> <hr size=1 noshade> <h3>Description: DB_TXN->discard</h3> <p>The DB_TXN->discard method frees up all the per-process resources associated with the specified <a href="../../db46-devel-4.6.21/api_c/txn_class.html">DB_TXN</a> handle, neither committing nor aborting the transaction. This call may be used only after calls to <a href="../../db46-devel-4.6.21/api_c/txn_recover.html">DB_ENV->txn_recover</a> when there are multiple global transaction managers recovering transactions in a single Berkeley DB environment. Any transactions returned by <a href="../../db46-devel-4.6.21/api_c/txn_recover.html">DB_ENV->txn_recover</a> that are not handled by the current global transaction manager should be discarded using DB_TXN->discard.</p> <p>The DB_TXN->discard method returns a non-zero error value on failure and 0 on success. </p> <p>After DB_TXN->discard has been called, regardless of its return, the <a href="../../db46-devel-4.6.21/api_c/txn_class.html">DB_TXN</a> handle may not be accessed again.</p> <h3>Parameters</h3> <dl compact> <dt><b>flags</b><dd>The <b>flags</b> parameter is currently unused, and must be set to 0. </dl> <h3>Errors</h3> <p>The DB_TXN->discard method may fail and return one of the following non-zero errors:</p> <dl compact> <dt>EINVAL<dd>If the transaction handle does not refer to a transaction that was recovered into a prepared but not yet completed state; or if an invalid flag value or parameter was specified. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../../db46-devel-4.6.21/api_c/env_class.html">DB_ENV</a>, <a href="../../db46-devel-4.6.21/api_c/txn_class.html">DB_TXN</a> <h3>See Also</h3> <a href="../../db46-devel-4.6.21/api_c/txn_list.html">Transaction Subsystem and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db46-devel-4.6.21/api_c/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a><a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1>Copyright (c) 1996,2007 Oracle. All rights reserved.</font> </body> </html>