# Db::set_encrypt

`

###

    #include <db_cxx.h>

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

# Description

Set the password used by the DbEnv and Db methods to perform encryption and decryption.

The flags value 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.

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 interface may not be called after the Db::open interface 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.

# Errors

The Db::set_encrypt method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

  Called after Db::open was called.

EOPNOTSUPP
  Cryptography is not available in this Berkeley DB release.

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. If a catastrophic error has occurred, the Db::set_encrypt method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

Db

# See Also

Databases and Related Methods`

Copyright Sleepycat Software