<!--$Id: dbc_close.so,v 10.35 2006/10/24 13:26:50 bostic Exp $--> <!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: Dbc::close</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> </head> <body bgcolor=white> <table width="100%"><tr valign=top> <td> <b>Dbc::close</b> </td> <td align=right> <a href="../api_cxx/api_core.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> <b><pre> #include <db_cxx.h> <p> int Dbc::close(void); </pre></b> <hr size=1 noshade> <b>Description: Dbc::close</b> <p>The Dbc::close method discards the cursor.</p> <p>It is possible for the Dbc::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 Dbc::close has been called, regardless of its return, the cursor handle may not be used again.</p> <p>The Dbc::close 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. </p> <br><b>Errors</b> <p>The Dbc::close method may fail and throw <a href="../api_cxx/except_class.html">DbException</a>, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:</p> <br> <b>EINVAL</b><ul compact><li>If the cursor is already closed; or if an invalid flag value or parameter was specified.</ul> <br> <p>If a transactional database environment operation was selected to resolve a deadlock, the Dbc::close method will fail and either return <a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a> or throw a <a href="../api_cxx/deadlock_class.html">DbDeadlockException</a> exception.</p> <p>If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time, the Dbc::close method will fail and either return <a href="../ref/program/errorret.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a> or throw a <a href="../api_cxx/lockng_class.html">DbLockNotGrantedException</a> exception.</p> <hr size=1 noshade> <br><b>Class</b> <a href="../api_cxx/dbc_class.html">Dbc</a> <br><b>See Also</b> <a href="../api_cxx/dbc_list.html">Database Cursors and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_cxx/api_core.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>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> </body> </html>