← Back to branch summary

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

« back to all changes in this revision

Viewing changes to libdb/docs/api_java/db_cursor.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
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* 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:
libdb/docs/api_java/db_cursor.html
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: Db.cursor</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>Db.cursor</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_java/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
 
import com.sleepycat.db.*;
24
 
<p>
25
 
public Dbc cursor(DbTxn txnid, int flags)
26
 
    throws DbException;
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The Db.cursor method
30
 
creates a cursor.
31
 
<p>If the operation is to be transaction-protected, the <b>txnid</b>
32
 
parameter is a transaction handle returned from <a href="../api_java/txn_begin.html">DbEnv.txn_begin</a>;
33
 
otherwise, null.
34
 
<p>To transaction-protect cursor operations, cursors must be opened and
35
 
closed within the context of a transaction, and the <b>txnid</b>
36
 
parameter specifies the transaction context in which the cursor may be
37
 
used.
38
 
<p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or
39
 
more of the following values:
40
 
<p><dl compact>
41
 
<p><dt><a name="Db.DB_DIRTY_READ">Db.DB_DIRTY_READ</a><dd>All read operations performed by the cursor may return modified but not
42
 
yet committed data.  Silently ignored if the <a href="../api_java/db_open.html#DB_DIRTY_READ">Db.DB_DIRTY_READ</a> flag
43
 
was not specified when the underlying database was opened.
44
 
<p><dt><a name="Db.DB_WRITECURSOR">Db.DB_WRITECURSOR</a><dd>Specify that the cursor will be used to update the database.  The
45
 
underlying database environment must have been opened using the
46
 
<a href="../api_java/env_open.html#DB_INIT_CDB">Db.DB_INIT_CDB</a> flag.
47
 
</dl>
48
 
<p>The Db.cursor method throws an exception that encapsulates a non-zero error value on
49
 
failure.
50
 
<h1>Errors</h1>
51
 
<p>The Db.cursor method may fail and throw an exception encapsulating a non-zero error for the following conditions:
52
 
<p><dl compact>
53
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
54
 
</dl>
55
 
<p>The Db.cursor method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
56
 
If a catastrophic error has occurred, the Db.cursor method may fail and
57
 
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
58
 
in which case all subsequent Berkeley DB calls will fail in the same way.
59
 
<h1>Class</h1>
60
 
<a href="../api_java/dbc_class.html">Dbc</a>
61
 
<h1>See Also</h1>
62
 
<a href="../api_java/dbc_list.html">Database Cursors and Related Methods</a>
63
 
</tt>
64
 
<table width="100%"><tr><td><br></td><td align=right>
65
 
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
66
 
</td></tr></table>
67
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
68
 
</body>
69
 
</html>