DbSequence::remove
|
|
#include <db_cxx.h>
int
DbSequence::remove(u_int32_t flags);
Description: DbSequence::remove
The DbSequence::remove method removes the sequence from the database. This
method should not be called if there are other open handles on this
sequence.
The DbSequence handle may not be accessed again after DbSequence::remove is
called, regardless of its return.
The DbSequence::remove 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.
Parameters
- flags
- The flags parameter must be set to 0 or by bitwise inclusively OR'ing together one
or more of the following values:
- DB_TXN_NOSYNC
- If the operation is implicitly transaction protected (the txnid
argument is NULL but the operation occurs to a transactional database),
do not synchronously flush the log when the transaction commits.
- txnid
- If the operation is part of an application-specified
transaction, the txnid parameter is a transaction handle
returned from DbEnv::txn_begin; otherwise NULL. If no transaction
handle is specified, but the
operation occurs in a transactional
database,
the operation will be implicitly transaction protected.
Errors
The DbSequence::remove method
may fail and throw
DbException,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:
- EINVAL
- An
invalid flag value or parameter was specified.
Class
DbSequence
See Also
Sequences and Related Methods
Copyright (c) 1996-2005 Sleepycat Software, Inc. - All rights reserved.