<!--$Id: db_cursor.so,v 10.34 2002/08/24 18:22:29 bostic Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB->cursor</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>DB->cursor</h1>
</td>
<td align=right>
<a href="../../db4-devel-4.1.25/api_c/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db.h>
<p>
int
DB->cursor(DB *db,
DB_TXN *txnid, DBC **cursorp, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The DB->cursor method
creates a cursor and copies a pointer to it into the memory to which
<b>cursorp</b> refers.
<p>If the operation is to be transaction-protected, the <b>txnid</b>
parameter is a transaction handle returned from <a href="../../db4-devel-4.1.25/api_c/txn_begin.html">DB_ENV->txn_begin</a>;
otherwise, NULL.
<p>To transaction-protect cursor operations, cursors must be opened and
closed within the context of a transaction, and the <b>txnid</b>
parameter specifies the transaction context in which the cursor may be
used.
<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_DIRTY_READ">DB_DIRTY_READ</a><dd>All read operations performed by the cursor may return modified but not
yet committed data. Silently ignored if the <a href="../../db4-devel-4.1.25/api_c/db_open.html#DB_DIRTY_READ">DB_DIRTY_READ</a> flag
was not specified when the underlying database was opened.
<p><dt><a name="DB_WRITECURSOR">DB_WRITECURSOR</a><dd>Specify that the cursor will be used to update the database. The
underlying database environment must have been opened using the
<a href="../../db4-devel-4.1.25/api_c/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag.
</dl>
<p>The DB->cursor method returns a non-zero error value on failure and 0 on success.
<h1>Errors</h1>
<p>The DB->cursor method may fail and return a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
</dl>
<p>The DB->cursor method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB->cursor method may fail and
return <a href="../../db4-devel-4.1.25/ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../../db4-devel-4.1.25/api_c/dbc_class.html">DBC</a>
<h1>See Also</h1>
<a href="../../db4-devel-4.1.25/api_c/dbc_list.html">Database Cursors and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db4-devel-4.1.25/api_c/c_index.html"><img src="../../db4-4.1.25/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.1.25/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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
909f302ad53a08b3685753343102c969
>
files
>
25
