<!--$Id: env_set_errpfx.so,v 10.30 2003/11/08 19:17:29 bostic Exp $--> <!--Copyright 1997-2003 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: DbEnv::set_errpfx</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> </head> <body bgcolor=white> <a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3>DbEnv::set_errpfx</h3> </td> <td align=right> <a href="../../db42-devel-4.2.52/api_cxx/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a> <a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a> </td></tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db_cxx.h> <p> void DbEnv::set_errpfx(const char *errpfx); <p> void DbEnv::get_errpfx(const char **errpfxp); </pre></h3> <hr size=1 noshade> <h3>Description: DbEnv::set_errpfx</h3> <a name="3"><!--meow--></a> <p>Set the prefix string that appears before error messages issued by Berkeley DB.</p> <p>The <a href="../../db42-devel-4.2.52/api_cxx/db_set_errpfx.html">Db::set_errpfx</a> and DbEnv::set_errpfx methods do not copy the memory to which the <b>errpfx</b> 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.</p> <p>The DbEnv::set_errpfx method may be called at any time during the life of the application.</p> <h3>Parameters</h3> <p><dl compact> <p><dt><b>errpfx</b><dd> The <b>errpfx</b> parameter is the application-specified error prefix for additional error messages. </dl> <hr size=1 noshade> <h3>Description: DbEnv::get_errpfx</h3> <p>The DbEnv::get_errpfx method returns the error prefix.</p> <p>The DbEnv::get_errpfx method may be called at any time during the life of the application.</p> <p>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. </p> <h3>Parameters</h3> <p><dl compact> <p><dt><b>errpfxp</b><dd> The DbEnv::get_errpfx method returns a reference to the error prefix in <b>errpfxp</b>. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../../db42-devel-4.2.52/api_cxx/env_class.html">DbEnv</a> <h3>See Also</h3> <a href="../../db42-devel-4.2.52/api_cxx/env_list.html">Database Environments and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db42-devel-4.2.52/api_cxx/api_index.html"><img src="../../db42-4.2.52/images/api.gif" alt="API"></a><a href="../../db42-devel-4.2.52/ref/toc.html"><img src="../../db42-4.2.52/images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1><a href="../../db42-devel-4.2.52/sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html>