<!--$Id: dbc_dup.html,v 1.1.1.1 2003/02/15 04:55:51 zarzycki Exp $--> <!--Copyright 1997-2002 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: Dbc.dup</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> </head> <body bgcolor=white> <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h1>Dbc.dup</h1> </td> <td align=right> <a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> import com.sleepycat.db.*; <p> public Dbc dup(int flags) throws DbException; </pre></h3> <h1>Description</h1> <p>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. <p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or more of the following values: <p><dl compact> <p><dt><a name="Db.DB_POSITION">Db.DB_POSITION</a><dd>The newly created cursor is initialized to refer to the same position in the database as the original cursor and hold the same locks. If the Db.DB_POSITION flag is not specified, then the created cursor is uninitialized and will behave like a cursor newly created using <a href="../api_java/db_cursor.html">Db.cursor</a>. </dl> <p>When using the Berkeley DB Concurrent Data Store product, there can be only one active write cursor at a time. For this reason, attempting to duplicate a cursor for which the <a href="../api_java/db_cursor.html#DB_WRITECURSOR">Db.DB_WRITECURSOR</a> flag was specified during creation will return an error. <p> If the <b>cursor</b> argument is not yet initialized, the Dbc.dup method throws an exception that encapsulates Db.EINVAL. Otherwise, the Dbc.dup method throws an exception that encapsulates a non-zero error value on failure. <h1>Errors</h1> <p>The Dbc.dup method may fail and throw an exception encapsulating a non-zero error for the following conditions: <p><dl compact> <p><dt>EINVAL<dd>An invalid flag value or parameter was specified. <p>The <b>cursor</b> argument was created using the <a href="../api_java/db_cursor.html#DB_WRITECURSOR">Db.DB_WRITECURSOR</a> flag in the Berkeley DB Concurrent Data Store product. </dl> <p>The Dbc.dup method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the Dbc.dup method may fail and throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls will fail in the same way. <h1>Class</h1> <a href="../api_java/dbc_class.html">Dbc</a> <h1>See Also</h1> <a href="../api_java/dbc_list.html">Database Cursors and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> </body> </html>