DB_TXN->discard

API Ref

#include <db.h>

int DB_TXN->discard(DB_TXN *tid, u_int32_t flags);


Description: DB_TXN->discard

The DB_TXN->discard method frees up all the per-process resources associated with the specified DB_TXN handle, neither committing nor aborting the transaction. This call may be used only after calls to DB_ENV->txn_recover when there are multiple global transaction managers recovering transactions in a single Berkeley DB environment. Any transactions returned by DB_ENV->txn_recover that are not handled by the current global transaction manager should be discarded using DB_TXN->discard.

The DB_TXN->discard method returns a non-zero error value on failure and 0 on success.

After DB_TXN->discard has been called, regardless of its return, the DB_TXN handle may not be accessed again.

Parameters

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

Errors

The DB_TXN->discard method may fail and return one of the following non-zero errors:

EINVAL
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.

Class

DB_ENV, DB_TXN

See Also

Transaction Subsystem and Related Methods

APIRef

Copyright (c) 1996-2004 Sleepycat Software, Inc. - All rights reserved.