← 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_cxx/db_set_encrypt.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_encrypt.html
1
 
<!--$Id$-->
2
 
<!--$Id$-->
3
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
4
 
<!--All rights reserved.-->
5
 
<!--See the file LICENSE for redistribution information.-->
6
 
<html>
7
 
<head>
8
 
<title>Berkeley DB: Db::set_encrypt</title>
9
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
10
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
11
 
</head>
12
 
<body bgcolor=white>
13
 
<a name="2"><!--meow--></a>
14
 
<table width="100%"><tr valign=top>
15
 
<td>
16
 
<h1>Db::set_encrypt</h1>
17
 
</td>
18
 
<td align=right>
19
 
<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>
20
 
</td></tr></table>
21
 
<hr size=1 noshade>
22
 
<tt>
23
 
<h3><pre>
24
 
#include &lt;db_cxx.h&gt;
25
 
<p>
26
 
int
27
 
Db::set_encrypt(const char *passwd, u_int32_t flags);
28
 
</pre></h3>
29
 
<h1>Description</h1>
30
 
<p>Set the password used by the <a href="../api_cxx/env_class.html">DbEnv</a> and <a href="../api_cxx/db_class.html">Db</a> methods to
31
 
perform encryption and decryption.
32
 
<p>The <b>flags</b> value must be set to 0 or
33
 
the following value:
34
 
<p><dl compact>
35
 
<p><dt><a name="DB_ENCRYPT_AES">DB_ENCRYPT_AES</a><dd>Use the Rijndael/AES (also known as the Advanced Encryption Standard
36
 
and Federal Information Processing Standard (FIPS) 197) algorithm for
37
 
encryption or decryption.
38
 
</dl>
39
 
<p>Because databases opened within Berkeley DB environments use the password
40
 
specified to the environment, it is an error to attempt to set a
41
 
password in a database created within an environment.
42
 
<p>The Db::set_encrypt interface may not be called after the <a href="../api_cxx/db_open.html">Db::open</a>
43
 
interface is called.
44
 
<p>The Db::set_encrypt method either returns a non-zero error value or throws an exception that
45
 
encapsulates a non-zero error value on failure, and returns 0 on success.
46
 
<h1>Errors</h1>
47
 
<p>The Db::set_encrypt method may fail and throw an exception or return a non-zero error for the following conditions:
48
 
<p><dl compact>
49
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
50
 
<p>Called after
51
 
<a href="../api_cxx/db_open.html">Db::open</a>
52
 
was called.
53
 
</dl>
54
 
<p><dl compact>
55
 
<p><dt>EOPNOTSUPP<dd>Cryptography is not available in this Berkeley DB release.
56
 
</dl>
57
 
<p>The Db::set_encrypt 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.
58
 
If a catastrophic error has occurred, the Db::set_encrypt method may fail and
59
 
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
60
 
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
61
 
in which case all subsequent Berkeley DB calls will fail in the same way.
62
 
<h1>Class</h1>
63
 
<a href="../api_cxx/db_class.html">Db</a>
64
 
<h1>See Also</h1>
65
 
<a href="../api_cxx/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_cxx/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>