Edit File - File Manager

Edit File: env_set_encrypt.html

<html>
<head>
<title>Berkeley DB: DbEnv::set_encrypt</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
DbEnv::set_encrypt
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

int
DbEnv::set_encrypt(const char *passwd, u_int32_t flags);

int
DbEnv::get_encrypt_flags(u_int32_t *flagsp);
</pre>
<hr size=1 noshade>
Description: DbEnv::set_encrypt
Set the password used by the Berkeley DB library to perform encryption and
decryption.
The DbEnv::set_encrypt method configures a database environment, not only operations
performed using the specified <a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a> handle.
The DbEnv::set_encrypt method may not be called after the <a href="../../db4-devel-4.7.25/api_cxx/env_open.html">DbEnv::open</a> method is
called.
If the database environment already exists when
<a href="../../db4-devel-4.7.25/api_cxx/env_open.html">DbEnv::open</a> is called, the information specified to DbEnv::set_encrypt
must be consistent with the existing environment or an error will be
returned.

The DbEnv::set_encrypt method
either returns a non-zero error value
or throws an exception that encapsulates a non-zero error value on
failure, and returns 0 on success.

Parameters 
 flags<ul compact><li>The flags parameter must be set to 0 or
the following value:
 
<a name="DB_ENCRYPT_AES">DB_ENCRYPT_AES</a><ul compact><li>Use the Rijndael/AES (also known as the Advanced Encryption Standard
and Federal Information Processing Standard (FIPS) 197) algorithm for
encryption or decryption.</ul>
 </ul>
 passwd<ul compact><li>The passwd parameter is the password used to perform encryption
and decryption.</ul>
 
 Errors
The DbEnv::set_encrypt method
may fail and throw
<a href="../../db4-devel-4.7.25/api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:
 
EINVAL<ul compact><li>If the method was called after
<a href="../../db4-devel-4.7.25/api_cxx/env_open.html">DbEnv::open</a>
was called; or if an
invalid flag value or parameter was specified.</ul>
 
 
EOPNOTSUPP<ul compact><li>Cryptography is not available in this Berkeley DB release.</ul>
 
<hr size=1 noshade>
Description: DbEnv::get_encrypt_flags
The DbEnv::get_encrypt_flags method returns the encryption flags.
The DbEnv::get_encrypt_flags method may be called at any time during the life of the
application.
The DbEnv::get_encrypt_flags method
either returns a non-zero error value
or throws an exception that encapsulates a non-zero error value on
failure, and returns 0 on success.

Parameters 
 flagsp<ul compact><li>The DbEnv::get_encrypt_flags method returns the
encryption flags in flagsp.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager