DbEnv::set_encrypt API Ref

#include <db_cxx.h>

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

int DbEnv::get_encrypt_flags(u_int32_t *flagsp);


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 DbEnv handle.

The DbEnv::set_encrypt method may not be called after the DbEnv::open method is called. If the database environment already exists when DbEnv::open 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 passwd

Errors

The DbEnv::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

EOPNOTSUPP

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


Class DbEnv
See Also Database Environments and Related Methods

APIRef

Copyright (c) 1996,2008 Oracle. All rights reserved.