← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to libdb/docs/api_cxx/db_set_bt_compare.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_cxx/db_set_bt_compare.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::set_bt_compare</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::set_bt_compare</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
 
extern "C" {
26
 
    typedef int (*bt_compare_fcn_type)(DB *, const DBT *, const DBT *);
27
 
};
28
 
int
29
 
Db::set_bt_compare(bt_compare_fcn_type bt_compare_fcn);
30
 
</pre></h3>
31
 
<h1>Description</h1>
32
 
<p>Set the Btree key comparison function.  The comparison function is
33
 
called when it is necessary to compare a key specified by the
34
 
application with a key currently stored in the tree.  The first argument
35
 
to the comparison function is the <a href="../api_cxx/dbt_class.html">Dbt</a> representing the
36
 
application supplied key; the second is the current tree's key.
37
 
<p>The comparison function must return an integer value less than, equal
38
 
to, or greater than zero if the first key argument is considered to be
39
 
respectively less than, equal to, or greater than the second key
40
 
argument.  In addition, the comparison function must cause the keys in
41
 
the database to be <i>well-ordered</i>.  The comparison function
42
 
must correctly handle any key values used by the application (possibly
43
 
including zero-length keys).  In addition, when Btree key prefix
44
 
comparison is being performed (see <a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a> for more
45
 
information), the comparison routine may be passed a prefix of any
46
 
database key.  The <b>data</b> and <b>size</b> fields of the
47
 
<a href="../api_cxx/dbt_class.html">Dbt</a> are the only fields that may be used for the purposes of
48
 
this comparison, and no particular alignment of the memory to which
49
 
by the <b>data</b> field refers may be assumed.
50
 
<p>If no comparison function is specified, the keys are compared lexically,
51
 
with shorter keys collating before longer keys.
52
 
<p>The Db::set_bt_compare method configures operations performed using the specified
53
 
<a href="../api_cxx/db_class.html">Db</a> handle, not all operations performed on the underlying
54
 
database.
55
 
<p>The Db::set_bt_compare interface may not be called after the <a href="../api_cxx/db_open.html">Db::open</a>
56
 
interface is called.
57
 
If the database already exists when
58
 
<a href="../api_cxx/db_open.html">Db::open</a> is called, the information specified to Db::set_bt_compare must
59
 
be the same as that historically used to create the database or
60
 
corruption can occur.
61
 
<p>The Db::set_bt_compare method either returns a non-zero error value or throws an exception that
62
 
encapsulates a non-zero error value on failure, and returns 0 on success.
63
 
<h1>Errors</h1>
64
 
<p>The Db::set_bt_compare method may fail and throw an exception or return a non-zero error for the following conditions:
65
 
<p><dl compact>
66
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
67
 
<p>Called after <a href="../api_cxx/db_open.html">Db::open</a> was called.
68
 
</dl>
69
 
<p>The Db::set_bt_compare 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.
70
 
If a catastrophic error has occurred, the Db::set_bt_compare method may fail and
71
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
72
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
73
 
in which case all subsequent Berkeley DB calls will fail in the same way.
74
 
<h1>Class</h1>
75
 
<a href="../api_cxx/db_class.html">Db</a>
76
 
<h1>See Also</h1>
77
 
<a href="../api_cxx/db_list.html">Databases and Related Methods</a>
78
 
</tt>
79
 
<table width="100%"><tr><td><br></td><td align=right>
80
 
<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>
81
 
</td></tr></table>
82
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
83
 
</body>
84
 
</html>