← 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_c/db_set_h_hash.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_c/db_set_h_hash.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-&gt;set_h_hash</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-&gt;set_h_hash</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_c/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.h&gt;
24
 
<p>
25
 
int
26
 
DB-&gt;set_h_hash(DB *db,
27
 
    u_int32_t (*h_hash_fcn)(DB *, const void *bytes, u_int32_t length));
28
 
</pre></h3>
29
 
<h1>Description</h1>
30
 
<p>Set a user-defined hash method; if no hash method is specified, a default
31
 
hash method is used.  Because no hash method performs equally well on all
32
 
possible data, the user may find that the built-in hash method performs
33
 
poorly with a particular data set.  User-specified hash functions must
34
 
take a pointer to a byte string and a length as arguments, and return a
35
 
value of type
36
 
<b>u_int32_t</b>.
37
 
The hash function must handle any key values used by the application
38
 
(possibly including zero-length keys).
39
 
<p>If a hash method is specified, <a href="../api_c/db_open.html">DB-&gt;open</a> will attempt to determine
40
 
whether the hash method specified is the same as the one with which the
41
 
database was created, and will fail if it detects that it is not.
42
 
<p>The DB-&gt;set_h_hash method configures operations performed using the specified
43
 
<a href="../api_c/db_class.html">DB</a> handle, not all operations performed on the underlying
44
 
database.
45
 
<p>The DB-&gt;set_h_hash interface may not be called after the <a href="../api_c/db_open.html">DB-&gt;open</a>
46
 
interface is called.
47
 
If the database already exists when
48
 
<a href="../api_c/db_open.html">DB-&gt;open</a> is called, the information specified to DB-&gt;set_h_hash must
49
 
be the same as that historically used to create the database or
50
 
corruption can occur.
51
 
<p>The DB-&gt;set_h_hash method returns a non-zero error value on failure and 0 on success.
52
 
<h1>Errors</h1>
53
 
<p>The DB-&gt;set_h_hash method may fail and return a non-zero error for the following conditions:
54
 
<p><dl compact>
55
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
56
 
<p>Called after <a href="../api_c/db_open.html">DB-&gt;open</a> was called.
57
 
</dl>
58
 
<p>The DB-&gt;set_h_hash method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
59
 
If a catastrophic error has occurred, the DB-&gt;set_h_hash method may fail and
60
 
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
61
 
in which case all subsequent Berkeley DB calls will fail in the same way.
62
 
<h1>Class</h1>
63
 
<a href="../api_c/db_class.html">DB</a>
64
 
<h1>See Also</h1>
65
 
<a href="../api_c/db_list.html">Databases and Related Methods</a>
66
 
</tt>
67
 
<table width="100%"><tr><td><br></td><td align=right>
68
 
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
69
 
</td></tr></table>
70
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
71
 
</body>
72
 
</html>