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

DbEnv::set_errpfx |

`

    #include <db_cxx.h>

    void
    DbEnv::set_errpfx(const char *errpfx);

    void
    DbEnv::get_errpfx(const char **errpfxp);

Description: DbEnv::set_errpfx

Set the prefix string that appears before error messages issued by Berkeley DB.

The Db::set_errpfx and DbEnv::set_errpfx methods do not copy the memory to which the errpfx parameter refers; rather, they maintain a reference to it. Although this allows applications to modify the error message prefix at any time (without repeatedly calling the interfaces), it means the memory must be maintained until the handle is closed.

The DbEnv::set_errpfx method configures operations performed using the specified DbEnv handle, not all operations performed on the underlying database environment.

The DbEnv::set_errpfx method may be called at any time during the life of the application.

Parameters
errpfx

- The errpfx parameter is the application-specified error prefix for additional error messages.

Description: DbEnv::get_errpfx

The DbEnv::get_errpfx method returns the error prefix.

The DbEnv::get_errpfx method may be called at any time during the life of the application.

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

- The DbEnv::get_errpfx method returns a reference to the error prefix in errpfxp.

Class DbEnv
See Also Database Environments and Related Methods`

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