Import BSDDB 4.7.25 (as of svn r89086)
This commit is contained in:
99
docs/api_cxx/env_set_encrypt.html
Normal file
99
docs/api_cxx/env_set_encrypt.html
Normal file
@@ -0,0 +1,99 @@
|
||||
<!--$Id: env_set_encrypt.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
||||
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
||||
<!--See the file LICENSE for redistribution information.-->
|
||||
<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>
|
||||
<b>DbEnv::set_encrypt</b>
|
||||
</td>
|
||||
<td align=right>
|
||||
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
|
||||
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
|
||||
</tr></table>
|
||||
<hr size=1 noshade>
|
||||
<tt>
|
||||
<b><pre>
|
||||
#include <db_cxx.h>
|
||||
<p>
|
||||
int
|
||||
DbEnv::set_encrypt(const char *passwd, u_int32_t flags);
|
||||
<p>
|
||||
int
|
||||
DbEnv::get_encrypt_flags(u_int32_t *flagsp);
|
||||
</pre></b>
|
||||
<hr size=1 noshade>
|
||||
<b>Description: DbEnv::set_encrypt</b>
|
||||
<p>Set the password used by the Berkeley DB library to perform encryption and
|
||||
decryption.</p>
|
||||
<p>The DbEnv::set_encrypt method configures a database environment, not only operations
|
||||
performed using the specified <a href="../api_cxx/env_class.html">DbEnv</a> handle.</p>
|
||||
<p>The DbEnv::set_encrypt method may not be called after the <a href="../api_cxx/env_open.html">DbEnv::open</a> method is
|
||||
called.
|
||||
If the database environment already exists when
|
||||
<a href="../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.
|
||||
</p>
|
||||
<p>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.
|
||||
</p>
|
||||
<b>Parameters</b> <br>
|
||||
<b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or
|
||||
the following value:
|
||||
<br>
|
||||
<b><a name="DB_ENCRYPT_AES">DB_ENCRYPT_AES</a></b><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>
|
||||
<br></ul>
|
||||
<b>passwd</b><ul compact><li>The <b>passwd</b> parameter is the password used to perform encryption
|
||||
and decryption.</ul>
|
||||
<br>
|
||||
<br><b>Errors</b>
|
||||
<p>The DbEnv::set_encrypt method
|
||||
may fail and throw
|
||||
<a href="../api_cxx/except_class.html">DbException</a>,
|
||||
encapsulating one of the following non-zero errors, or return one of
|
||||
the following non-zero errors:</p>
|
||||
<br>
|
||||
<b>EINVAL</b><ul compact><li>If the method was called after
|
||||
<a href="../api_cxx/env_open.html">DbEnv::open</a>
|
||||
was called; or if an
|
||||
invalid flag value or parameter was specified.</ul>
|
||||
<br>
|
||||
<br>
|
||||
<b>EOPNOTSUPP</b><ul compact><li>Cryptography is not available in this Berkeley DB release.</ul>
|
||||
<br>
|
||||
<hr size=1 noshade>
|
||||
<b>Description: DbEnv::get_encrypt_flags</b>
|
||||
<p>The DbEnv::get_encrypt_flags method returns the encryption flags.</p>
|
||||
<p>The DbEnv::get_encrypt_flags method may be called at any time during the life of the
|
||||
application.</p>
|
||||
<p>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.
|
||||
</p>
|
||||
<b>Parameters</b> <br>
|
||||
<b>flagsp</b><ul compact><li>The DbEnv::get_encrypt_flags method returns the
|
||||
encryption flags in <b>flagsp</b>.</ul>
|
||||
<br>
|
||||
<hr size=1 noshade>
|
||||
<br><b>Class</b>
|
||||
<a href="../api_cxx/env_class.html">DbEnv</a>
|
||||
<br><b>See Also</b>
|
||||
<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a>
|
||||
</tt>
|
||||
<table width="100%"><tr><td><br></td><td align=right>
|
||||
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
|
||||
</td></tr></table>
|
||||
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user