2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: Db::cursor</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>
18
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
23
#include <db_cxx.h>
26
Db::cursor(DbTxn *txnid, Dbc **cursorp, u_int32_t flags);
29
<p>The Db::cursor method
30
creates a cursor and copies a pointer to it into the memory to which
31
<b>cursorp</b> refers.
32
<p>If the operation is to be transaction-protected, the <b>txnid</b>
33
parameter is a transaction handle returned from <a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>;
35
<p>To transaction-protect cursor operations, cursors must be opened and
36
closed within the context of a transaction, and the <b>txnid</b>
37
parameter specifies the transaction context in which the cursor may be
39
<p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or
40
more of the following values:
42
<p><dt><a name="DB_DIRTY_READ">DB_DIRTY_READ</a><dd>All read operations performed by the cursor may return modified but not
43
yet committed data. Silently ignored if the <a href="../api_cxx/db_open.html#DB_DIRTY_READ">DB_DIRTY_READ</a> flag
44
was not specified when the underlying database was opened.
45
<p><dt><a name="DB_WRITECURSOR">DB_WRITECURSOR</a><dd>Specify that the cursor will be used to update the database. The
46
underlying database environment must have been opened using the
47
<a href="../api_cxx/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag.
49
<p>The Db::cursor method either returns a non-zero error value or throws an exception that
50
encapsulates a non-zero error value on failure, and returns 0 on success.
52
<p>The Db::cursor method may fail and throw an exception or return a non-zero error for the following conditions:
54
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
56
<p>The Db::cursor 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.
57
If a catastrophic error has occurred, the Db::cursor method may fail and
58
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
59
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
60
in which case all subsequent Berkeley DB calls will fail in the same way.
62
<a href="../api_cxx/dbc_class.html">Dbc</a>
64
<a href="../api_cxx/dbc_list.html">Database Cursors and Related Methods</a>
66
<table width="100%"><tr><td><br></td><td align=right>
67
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
69
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>