2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: DBcursor->c_dup</title>
8
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
12
<a name="2"><!--meow--></a>
13
<table width="100%"><tr valign=top>
15
<h1>DBcursor->c_dup</h1>
18
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
26
DBcursor->c_dup(DBC *cursor, DBC **cursorp, u_int32_t flags);
29
<p>The DBcursor->c_dup method creates a new cursor that uses the same transaction
30
and locker ID as the original cursor. This is useful when an application
31
is using locking and requires two or more cursors in the same thread of
33
<p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or
34
more of the following values:
36
<p><dt><a name="DB_POSITION">DB_POSITION</a><dd>The newly created cursor is initialized to refer to the same position
37
in the database as the original cursor and hold the same locks. If the
38
DB_POSITION flag is not specified, then the created cursor is
39
uninitialized and will behave like a cursor newly created using
40
<a href="../api_c/db_cursor.html">DB->cursor</a>.
42
<p>When using the Berkeley DB Concurrent Data Store product, there can be only one active write cursor
43
at a time. For this reason, attempting to duplicate a cursor for which
44
the <a href="../api_c/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a> flag was specified during creation will return
47
If the <b>cursor</b> argument is not yet initialized, the DBcursor->c_dup method will return EINVAL.
48
Otherwise, the DBcursor->c_dup method returns a non-zero error value on failure and 0 on success.
50
<p>The DBcursor->c_dup method may fail and return a non-zero error for the following conditions:
52
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
53
<p>The <b>cursor</b> argument was created using the
54
<a href="../api_c/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a> flag in the Berkeley DB Concurrent Data Store product.
56
<p>The DBcursor->c_dup method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
57
If a catastrophic error has occurred, the DBcursor->c_dup method may fail and
58
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
59
in which case all subsequent Berkeley DB calls will fail in the same way.
61
<a href="../api_c/dbc_class.html">DBC</a>
63
<a href="../api_c/dbc_list.html">Database Cursors and Related Methods</a>
65
<table width="100%"><tr><td><br></td><td align=right>
66
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
68
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>