~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/dbc_close.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
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++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>Dbc::close</h1>
16
 
</td>
17
 
<td align=right>
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>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
#include &lt;db_cxx.h&gt;
24
 
<p>
25
 
int
26
 
Dbc::close(void);
27
 
</pre></h3>
28
 
<h1>Description</h1>
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
34
 
proceed.
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.
39
 
<h1>Errors</h1>
40
 
<p>The Dbc::close method may fail and throw an exception or return a non-zero error for the following conditions:
41
 
<p><dl compact>
42
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
43
 
<p>The cursor was previously closed.
44
 
</dl>
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.
54
 
<h1>Class</h1>
55
 
<a href="../api_cxx/dbc_class.html">Dbc</a>
56
 
<h1>See Also</h1>
57
 
<a href="../api_cxx/dbc_list.html">Database Cursors and Related Methods</a>
58
 
</tt>
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>
61
 
</td></tr></table>
62
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
63
 
</body>
64
 
</html>