<!--$Id: db_set_error_stream.so,v 10.2 2002/08/18 21:15:54 bostic Exp $--> <!--$Id: env_set_error_stream.so,v 10.30 2006/02/10 22:54:59 bostic Exp $--> <!--Copyright (c) 1997,2007 Oracle. All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: Db::set_error_stream</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> <meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> </head> <body bgcolor=white> <table width="100%"><tr valign=top> <td> <h3>Db::set_error_stream</h3> </td> <td align=right> <a href="../../db46-devel-4.6.21/api_cxx/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a> <a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a></td> </tr></table> <hr size=1 noshade> <tt> <h3><pre> #include <db_cxx.h> <p> void Db::set_error_stream(class ostream*); </pre></h3> <hr size=1 noshade> <h3>Description: Db::set_error_stream</h3> <p>When an error occurs in the Berkeley DB library, an exception is thrown or an <b>errno</b> value is returned by the interface. In some cases, however, the <b>errno</b> value may be insufficient to completely describe the cause of the error, especially during initial application debugging.</p> <p>The <a href="../../db46-devel-4.6.21/api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> and Db::set_error_stream methods are used to enhance the mechanism for reporting error messages to the application by setting the C++ ostream used for displaying additional Berkeley DB error messages. In some cases, when an error occurs, Berkeley DB will output an additional error message to the specified stream.</p> <p>The error message will consist of the prefix string and a colon ("<b>:</b>") (if a prefix string was previously specified using <a href="../../db46-devel-4.6.21/api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>), an error string, and a trailing <newline> character.</p> <p>Setting <b>stream</b> to NULL unconfigures the interface.</p> <p>Alternatively, you can use the <a href="../../db46-devel-4.6.21/api_cxx/env_set_errfile.html">DbEnv::set_errfile</a> and <a href="../../db46-devel-4.6.21/api_cxx/db_set_errfile.html">Db::set_errfile</a> methods to display the additional information via a C library FILE *, or the <a href="../../db46-devel-4.6.21/api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> and <a href="../../db46-devel-4.6.21/api_cxx/db_set_errcall.html">Db::set_errcall</a> methods to capture the additional error information in a way that does not use either output streams or C library FILE *'s. You should not mix these approaches.</p> <p>This error-logging enhancement does not slow performance or significantly increase application size, and may be run during normal operation as well as during application debugging.</p> <p>For <a href="../../db46-devel-4.6.21/api_cxx/db_class.html">Db</a> handles opened inside of Berkeley DB environments, calling the Db::set_error_stream method affects the entire environment and is equivalent to calling the <a href="../../db46-devel-4.6.21/api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> method.</p> <p>The Db::set_error_stream method configures operations performed using the specified <a href="../../db46-devel-4.6.21/api_cxx/db_class.html">Db</a> handle, not all operations performed on the underlying database.</p> <p>The Db::set_error_stream method may be called at any time during the life of the application.</p> <h3>Parameters</h3> <dl compact> <dt><b>stream</b><dd>The <b>stream</b> parameter is the application-specified output stream to be used for additional error information. </dl> <hr size=1 noshade> <h3>Class</h3> <a href="../../db46-devel-4.6.21/api_cxx/db_class.html">Db</a> <h3>See Also</h3> <a href="../../db46-devel-4.6.21/api_cxx/db_list.html">Databases and Related Methods</a> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../../db46-devel-4.6.21/api_cxx/api_core.html"><img src="../../db46-devel-4.6.21/images/api.gif" alt="API"></a><a href="../../db46-devel-4.6.21/ref/toc.html"><img src="../../db46-devel-4.6.21/images/ref.gif" alt="Ref"></a> </td></tr></table> <p><font size=1>Copyright (c) 1996,2007 Oracle. All rights reserved.</font> </body> </html>