<!--$Id: db_cursor.so,v 10.25 2000/07/11 19:11:25 bostic Exp $--> <!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <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><tr valign=top> <td> <h1>Db.cursor</h1> </td> <td width="1%"> <a href="../api_java/java_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> import com.sleepycat.db.*; <p> public Dbc cursor(DbTxn txnid, int flags) throws DbException; </pre></h3> <h1>Description</h1> <p>The Db.cursor method creates a cursor. <p>If the file is being accessed under transaction protection, the <b>txnid</b> parameter is a transaction ID returned from <a href="../api_java/txn_begin.html">DbEnv.txn_begin</a>, otherwise, NULL. <p>If transaction protection is enabled, 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.DB_WRITECURSOR">Db.DB_WRITECURSOR</a><dd>Specify that the cursor will be used to update the database. This flag should <b>only</b> be set when the <a href="../api_java/env_open.html#DB_INIT_CDB">Db.DB_INIT_CDB</a> flag was specified to <a href="../api_java/env_open.html">DbEnv.open</a>. </dl> <p>The Db.cursor method throws an exception that encapsulates a non-zero error value on failure. <h1>Errors</h1> <p>The Db.cursor 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. </dl> <p>The Db.cursor 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 Db.cursor 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. <h3>Class</h3> <a href="../api_java/db_class.html">Db</a> <h1>See Also</h1> <a href="../api_java/db_close.html">Db.close</a>, <a href="../api_java/db_cursor.html">Db.cursor</a>, <a href="../api_java/db_del.html">Db.del</a>, <a href="../api_java/db_fd.html">Db.fd</a>, <a href="../api_java/db_get.html">Db.get</a>, <a href="../api_java/db_get_byteswapped.html">Db.get_byteswapped</a>, <a href="../api_java/db_get_type.html">Db.get_type</a>, <a href="../api_java/db_join.html">Db.join</a>, <a href="../api_java/db_key_range.html">Db.key_range</a>, <a href="../api_java/db_open.html">Db.open</a>, <a href="../api_java/db_put.html">Db.put</a>, <a href="../api_java/db_remove.html">Db.remove</a>, <a href="../api_java/db_set_bt_minkey.html">Db.set_bt_minkey</a>, <a href="../api_java/db_set_cachesize.html">Db.set_cachesize</a>, <a href="../api_java/db_set_errcall.html">Db.set_errcall</a>, <a href="../api_java/db_set_errpfx.html">Db.set_errpfx</a>, <a href="../api_java/db_set_flags.html">Db.set_flags</a>, <a href="../api_java/db_set_h_ffactor.html">Db.set_h_ffactor</a>, <a href="../api_java/db_set_h_nelem.html">Db.set_h_nelem</a>, <a href="../api_java/db_set_lorder.html">Db.set_lorder</a>, <a href="../api_java/db_set_pagesize.html">Db.set_pagesize</a>, <a href="../api_java/db_set_q_extentsize.html">Db.set_q_extentsize</a>, <a href="../api_java/db_set_re_delim.html">Db.set_re_delim</a>, <a href="../api_java/db_set_re_len.html">Db.set_re_len</a>, <a href="../api_java/db_set_re_pad.html">Db.set_re_pad</a>, <a href="../api_java/db_set_re_source.html">Db.set_re_source</a>, <a href="../api_java/db_stat.html">Db.stat</a>, <a href="../api_java/db_sync.html">Db.sync</a>, <a href="../api_java/db_upgrade.html">Db.upgrade</a> and <a href="../api_java/db_verify.html">Db.verify</a>. </tt> <table><tr><td><br></td><td width="1%"> <a href="../api_java/java_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>