Berkeley DB: Db::set_encrypt
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++

### Db::set_encrypt |

`

###

    #include <db_cxx.h>

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

    int
    Db::get_encrypt_flags(u_int32_t *flagsp);

### Description: Db::set_encrypt

Set the password used by the Berkeley DB library to perform encryption and decryption.

Because databases opened within Berkeley DB environments use the password specified to the environment, it is an error to attempt to set a password in a database created within an environment.

The Db::set_encrypt method may not be called after the Db::open method is called.

The Db::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
  The flags parameter must be set to 0 or the following value:

  DB_ENCRYPT_AES
    Use the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing Standard (FIPS) 197) algorithm for encryption or decryption.

passwd
  The passwd parameter is the password used to perform encryption and decryption.

### Errors

The Db::set_encrypt method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

EINVAL
  If the method was called after Db::open was called; or if an invalid flag value or parameter was specified.

EOPNOTSUPP
  Cryptography is not available in this Berkeley DB release.

### Description: Db::get_encrypt_flags

The Db::get_encrypt_flags method returns the encryption flags.

The Db::get_encrypt_flags method may be called at any time during the life of the application.

The Db::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
  The Db::get_encrypt_flags method returns the encryption flags in flagsp.

### Class

Db

### See Also

Databases and Related Methods`

Copyright (c) 1996-2003 Sleepycat Software, Inc. - All rights reserved.