db_err.html   [plain text]


<!--$Id: db_err.html,v 1.1.1.1 2003/02/15 04:55:50 zarzycki Exp $-->
<!--$Id: db_err.html,v 1.1.1.1 2003/02/15 04:55:50 zarzycki Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db.err</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>
<h1>Db.err</h1>
</td>
<td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
import com.sleepycat.db.*;
<p>
public void err(int errcode, String message)
<p>
public void errx(String message)
</pre></h3>
<h1>Description</h1>
<p>The <a href="../api_java/env_err.html">DbEnv.err</a>, <a href="../api_java/env_err.html">DbEnv.errx</a>,  Db.err and
Db.errx methods provide error-messaging functionality for
applications written using the Berkeley DB library.
<p>The <a href="../api_java/env_err.html">DbEnv.err</a> method constructs an error message consisting of the
following elements:
<p><blockquote><p><dl compact>
<p><dt>An optional prefix string<dd>If no error callback method has been set using the
<a href="../api_java/env_set_errcall.html">DbEnv.set_errcall</a> method, any prefix string specified using the
<a href="../api_java/env_set_errpfx.html">DbEnv.set_errpfx</a> method, followed by two separating characters: a colon
and a &lt;space&gt; character.
<p><dt>The supplied message string <b>message</b>.<dd>
<p><dt>A separator<dd>Two separating characters: a colon and a &lt;space&gt; character.
<p><dt>A standard error string<dd>The standard system or Berkeley DB library error string associated with the
<b>error</b> value, as returned by the <a href="../api_java/env_strerror.html">DbEnv.strerror</a> method.
</dl>
</blockquote>
<p>This constructed error message is then handled as follows:
<p><blockquote>
<p>If an error callback method has been set (see <a href="../api_java/db_set_errcall.html">Db.set_errcall</a>
and <a href="../api_java/env_set_errcall.html">DbEnv.set_errcall</a>), that method is called with two
arguments: any prefix string specified (see <a href="../api_java/db_set_errpfx.html">Db.set_errpfx</a> and
<a href="../api_java/env_set_errpfx.html">DbEnv.set_errpfx</a>) and the error message.
<p>If an OutputStream has been set
(see <a href="../api_java/env_set_error_stream.html">DbEnv.set_error_stream</a> and <a href="../api_java/db_set_error_stream.html">Db.set_error_stream</a>),
the error message is written to that stream.
<p>If none of these output options has been configured, the error message
is written to System.err, the standard
error output stream.</blockquote>
<p>The <a href="../api_java/env_err.html">DbEnv.errx</a> and Db.errx methods perform identically to the
<a href="../api_java/env_err.html">DbEnv.err</a> and Db.err methods, except that they do not append
the final separator characters and standard error string to the error
message.
<h1>Class</h1>
<a href="../api_java/db_class.html">Db</a>
<h1>See Also</h1>
<a href="../api_java/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>