Dbc::dup

API Ref

#include <db_cxx.h>

int Dbc::dup(Dbc **cursorp, u_int32_t flags);


Description: Dbc::dup

The Dbc::dup method creates a new cursor that uses the same transaction and locker ID as the original cursor. This is useful when an application is using locking and requires two or more cursors in the same thread of control.

The Dbc::dup 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_POSITION
The newly created cursor is initialized to refer to the same position in the database as the original cursor (if any) and hold the same locks (if any). If the DB_POSITION flag is not specified, or the original cursor does not hold a database position and locks, the created cursor is uninitialized and will behave like a cursor newly created using Db::cursor.

Errors

The Dbc::dup method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

DB_REP_HANDLE_DEAD
The database handle has been invalidated because a replication election unrolled a committed transaction.
EINVAL
An invalid flag value or parameter was specified.

Class

Dbc

See Also

Database Cursors and Related Methods

APIRef

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