2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: Dbc::close</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>
29
<p>The Dbc::close method discards the cursor.
30
<p>It is possible for the Dbc::close method to return
31
<a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a>, signaling that any enclosing transaction should
32
be aborted. If the application is already intending to abort the
33
transaction, this error should be ignored, and the application should
35
<p>After Dbc::close has been called, regardless of its return, the
36
cursor handle may not be used again.
37
<p>The Dbc::close method either returns a non-zero error value or throws an exception that
38
encapsulates a non-zero error value on failure, and returns 0 on success.
40
<p>The Dbc::close method may fail and throw an exception or return a non-zero error for the following conditions:
42
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
43
<p>The cursor was previously closed.
45
<p>If the operation was selected to resolve a deadlock, the
46
Dbc::close method will fail and
47
and either return <a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a> or
48
throw a <a href="../api_cxx/deadlock_class.html">DbDeadlockException</a> exception.
49
<p>The Dbc::close 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.
50
If a catastrophic error has occurred, the Dbc::close method may fail and
51
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
52
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
53
in which case all subsequent Berkeley DB calls will fail in the same way.
55
<a href="../api_cxx/dbc_class.html">Dbc</a>
57
<a href="../api_cxx/dbc_list.html">Database Cursors and Related Methods</a>
59
<table width="100%"><tr><td><br></td><td align=right>
60
<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>
62
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>