70 lines
3.0 KiB
HTML
70 lines
3.0 KiB
HTML
<!--$Id: txn_discard.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
|
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
|
<!--See the file LICENSE for redistribution information.-->
|
|
<html>
|
|
<head>
|
|
<title>Berkeley DB: DbTxn::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>
|
|
<b>DbTxn::discard</b>
|
|
</td>
|
|
<td align=right>
|
|
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
|
|
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
|
|
</tr></table>
|
|
<hr size=1 noshade>
|
|
<tt>
|
|
<b><pre>
|
|
#include <db_cxx.h>
|
|
<p>
|
|
int
|
|
DbTxn::discard(u_int32_t flags);
|
|
</pre></b>
|
|
<hr size=1 noshade>
|
|
<b>Description: DbTxn::discard</b>
|
|
<p>The DbTxn::discard method frees up all the per-process resources
|
|
associated with the specified <a href="../api_cxx/txn_class.html">DbTxn</a> handle, neither committing
|
|
nor aborting the transaction. This call may be used only after calls
|
|
to <a href="../api_cxx/txn_recover.html">DbEnv::txn_recover</a> when there are multiple global transaction
|
|
managers recovering transactions in a single Berkeley DB environment. Any
|
|
transactions returned by <a href="../api_cxx/txn_recover.html">DbEnv::txn_recover</a> that are not handled by
|
|
the current global transaction manager should be discarded using
|
|
DbTxn::discard.</p>
|
|
<p>The DbTxn::discard 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>
|
|
<p>After DbTxn::discard has been called, regardless of its return, the
|
|
<a href="../api_cxx/txn_class.html">DbTxn</a> handle may not be accessed again.</p>
|
|
<b>Parameters</b> <br>
|
|
<b>flags</b><ul compact><li>The <b>flags</b> parameter is currently unused, and must be set to 0.</ul>
|
|
<br>
|
|
<br><b>Errors</b>
|
|
<p>The DbTxn::discard method
|
|
may fail and throw
|
|
<a href="../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>
|
|
<br>
|
|
<b>EINVAL</b><ul compact><li>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.</ul>
|
|
<br>
|
|
<hr size=1 noshade>
|
|
<br><b>Class</b>
|
|
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a>
|
|
<br><b>See Also</b>
|
|
<a href="../api_cxx/txn_list.html">Transaction Subsystem and Related Methods</a>
|
|
</tt>
|
|
<table width="100%"><tr><td><br></td><td align=right>
|
|
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
|
|
</td></tr></table>
|
|
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
|
</body>
|
|
</html>
|