<!--$Id: dbc_close.html,v 1.2 2004/03/30 01:21:42 jtownsen Exp $--> <!--Copyright 1997-2003 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DBcursor->c_close</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> <h3>DBcursor->c_close</h3> </td> <td align=right> <a href="../api_c/api_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.h> <p> int DBcursor->c_close(DBC *DBcursor); </pre></h3> <hr size=1 noshade> <h3>Description: DBcursor->c_close</h3> <p>The DBcursor->c_close method discards the cursor.</p> <p>It is possible for the DBcursor->c_close method to return <a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a>, signaling that any enclosing transaction should be aborted. If the application is already intending to abort the transaction, this error should be ignored, and the application should proceed.</p> <p>After DBcursor->c_close has been called, regardless of its return, the cursor handle may not be used again.</p> <p>The DBcursor->c_close method returns a non-zero error value on failure and 0 on success. </p> <h3>Errors</h3> <p>The DBcursor->c_close method may fail and return one of the following non-zero errors:</p> <p><dl compact> <p><dt>DB_LOCK_DEADLOCK<dd>A transactional database environment operation was selected to resolve a deadlock. <p><dt>DB_LOCK_NOTGRANTED<dd>A Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time. </dl> <p><dl compact> <p><dt>EINVAL<dd>If the cursor is already closed; or if an invalid flag value or parameter was specified. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../api_c/dbc_class.html">DBC</a> <h3>See Also</h3> <a href="../api_c/dbc_list.html">Database Cursors and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_c/api_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="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html>