mirror of
https://github.com/MariaDB/server.git
synced 2025-11-09 11:41:36 +03:00
77 lines
3.8 KiB
HTML
77 lines
3.8 KiB
HTML
<!--$Id: dbc_dup.so,v 10.8 2000/03/17 01:53:58 bostic Exp $-->
|
|
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
|
|
<!--All rights reserved.-->
|
|
<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><tr valign=top>
|
|
<td>
|
|
<h1>Dbc::dup</h1>
|
|
</td>
|
|
<td width="1%">
|
|
<a href="../api_cxx/cxx_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
|
|
</td></tr></table>
|
|
<hr size=1 noshade>
|
|
<tt>
|
|
<h3><pre>
|
|
#include <db_cxx.h>
|
|
<p>
|
|
int
|
|
Dbc::dup(Dbc **cursorp, u_int32_t flags);
|
|
</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_POSITION">DB_POSITION</a><dd>The newly created cursor is initialized to reference the same position
|
|
in the database as the original cursor and hold the same locks. If the
|
|
DB_POSITION flag is not specified, then the created cursor is
|
|
uninitialized and will behave like a cursor newly created using
|
|
<a href="../api_cxx/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_cxx/db_cursor.html#DB_WRITECURSOR">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 either returns EINVAL or throws an exception that encapsulates EINVAL.
|
|
<p>Otherwise, 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.
|
|
<h1>Errors</h1>
|
|
<p>The Dbc::dup method may fail and throw an exception or return 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_cxx/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a> flag in the Berkeley DB Concurrent Data Store product.
|
|
</dl>
|
|
<p>The Dbc::dup method may fail and throw an exception or return a non-zero error 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 either
|
|
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating
|
|
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
|
|
in the same way.
|
|
<h3>Class</h3>
|
|
<a href="../api_cxx/dbc_class.html">Dbc</a>
|
|
<h1>See Also</h1>
|
|
<a href="../api_cxx/dbc_close.html">Dbc::close</a>,
|
|
<a href="../api_cxx/dbc_count.html">Dbc::count</a>,
|
|
<a href="../api_cxx/dbc_del.html">Dbc::del</a>,
|
|
<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>,
|
|
<a href="../api_cxx/dbc_get.html">Dbc::get</a>
|
|
and
|
|
<a href="../api_cxx/dbc_put.html">Dbc::put</a>.
|
|
</tt>
|
|
<table><tr><td><br></td><td width="1%">
|
|
<a href="../api_cxx/cxx_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.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>
|