DbSequence::set

DbSequence::set_flags()
Prev	Chapter 12. The DbSequence Handle	Next

DbSequence::set_flags()

#include <db_cxx.h>

int
DbSequence::set_flags(u_int32_t flags);

Configure a sequence. The flags are only effective when creating a sequence. Calling DbSequence::set_flags() is additive; there is no way to clear flags.

The DbSequence::set_flags() method may not be called after the DbSequence::open() method is called.

The DbSequence::set_flags() 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_SEQ_DEC

Specify that the sequence should be decremented.
DB_SEQ_INC

Specify that the sequence should be incremented. This is the default.
DB_SEQ_WRAP

Specify that the sequence should wrap around when it is incremented (decremented) past the specified maximum (minimum) value.

Errors

The DbSequence::set_flags() method may fail and throw a DbException exception, 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

Prev	Up	Next
DbSequence::set_cachesize()	Home	DbSequence::set_range()