1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
<!--$Id: env_set_error_stream.so,v 10.29 2004/08/13 03:38:57 bostic Exp $-->
<!--Copyright 1997-2004 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv::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>DbEnv::set_error_stream</h3>
</td>
<td align=right>
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include <db_cxx.h>
<p>
void DbEnv::set_error_stream(class ostream*);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DbEnv::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 DbEnv::set_error_stream and <a href="../api_cxx/db_set_error_stream.html">Db::set_error_stream</a> 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="../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="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a> and
<a href="../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="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> and
<a href="../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>
<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="../api_cxx/env_class.html">DbEnv</a>
<h3>See Also</h3>
<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>
|
