#include <db_cxx.h>

DbSequence::stat(DB_SEQUENCE_STAT **spp, u_int32_t flags); 

The DbSequence::stat() method creates a statistical structure and copies a pointer to it into user-specified memory locations. Specifically, if spp is non-NULL, a pointer to the statistics for the database are copied into the memory location to which it refers.

Statistical structures are stored in allocated memory. If application-specific allocation routines have been declared (see DbEnv::set_alloc() for more information), they are used to allocate the memory; otherwise, the standard C library malloc(3) is used. The caller is responsible for deallocating the memory. To deallocate the memory, free the memory reference; references inside the returned memory need not be individually freed.

In the presence of multiple threads or processes accessing an active sequence, the information returned by DbSequence::stat() may be out-of-date.

The DbSequence::stat() method cannot be transaction-protected. For this reason, it should be called in a thread of control that has no open cursors or active transactions.

The DbSequence::stat() 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.

The statistics are stored in a structure of type DB_SEQUENCE_STAT. The following fields will be filled in:



The flags parameter must be set by bitwise inclusively OR'ing together one or more of the following values:


    Display all available information.


    Reset statistics after printing their values.



See Also

Sequences and Related Methods