Edit File - File Manager

Edit File: db_set_error_stream.html

<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>
Db::set_error_stream
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

void Db::set_error_stream(class ostream*);
</pre>
<hr size=1 noshade>
Description: Db::set_error_stream
When an error occurs in the Berkeley DB library, an exception is thrown or an
errno value is returned by the interface. In some cases,
however, the errno value may be insufficient to completely
describe the cause of the error, especially during initial application
debugging.
The <a href="../../db4-devel-4.7.25/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.
The error message will consist of the prefix string and a colon
(":") (if a prefix string was previously specified using
<a href="../../db4-devel-4.7.25/api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>), an error string, and a trailing
&lt;newline&gt; character.
Setting stream to NULL unconfigures the interface.
Alternatively, you can use the <a href="../../db4-devel-4.7.25/api_cxx/env_set_errfile.html">DbEnv::set_errfile</a> and
<a href="../../db4-devel-4.7.25/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="../../db4-devel-4.7.25/api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> and
<a href="../../db4-devel-4.7.25/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.
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.
For <a href="../../db4-devel-4.7.25/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="../../db4-devel-4.7.25/api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> method.
The Db::set_error_stream method configures operations performed using the specified
<a href="../../db4-devel-4.7.25/api_cxx/db_class.html">Db</a> handle, not all operations performed on the underlying
database.
The Db::set_error_stream method may be called at any time during the life of the
application.
Parameters 
 stream<ul compact><li>The stream parameter is the application-specified output stream to
be used for additional error information.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/db_class.html">Db</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager