DB_SEQUENCE->remove

API Ref

#include <db.h>

int DB_SEQUENCE->remove(DB_SEQUENCE *seq, DB_TXN *txnid, u_int32_t flags);


Description: DB_SEQUENCE->remove

The DB_SEQUENCE->remove method removes the sequence from the database. This method should not be called if there are other open handles on this sequence.

The DB_SEQUENCE handle may not be accessed again after DB_SEQUENCE->remove is called, regardless of its return.

The DB_SEQUENCE->remove method returns a non-zero error value on failure and 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_AUTO_COMMIT
The remove will be enclosed in a transaction and will be recoverable.
DB_TXN_NOSYNC
If a DB_AUTO_COMMIT triggers a transaction, do not synchronously flush the log.
txnid
If the operation is to be transaction-protected, the txnid parameter is a transaction handle returned from DB_ENV->txn_begin; otherwise, NULL.

Errors

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

EINVAL
An invalid flag value or parameter was specified.

Class

DB_SEQUENCE

See Also

Sequences and Related Methods

APIRef

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