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 70 71 72 73 74 75 76 77
|
<!--$Id: db_err.html,v 1.1.1.1 2003/11/20 22:14:24 toshok Exp $-->
<!--$Id: db_err.html,v 1.1.1.1 2003/11/20 22:14:24 toshok 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_c/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>
#include <db.h>
<p>
void
DB->err(DB *db, int error, const char *fmt, ...);
<p>
void
DB->errx(DB *db, const char *fmt, ...);
</pre></h3>
<h1>Description</h1>
<p>The <a href="../api_c/env_err.html">DB_ENV->err</a>, <a href="../api_c/env_err.html">DB_ENV->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_c/env_err.html">DB_ENV->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 function has been set using the
<a href="../api_c/env_set_errcall.html">DB_ENV->set_errcall</a> method, any prefix string specified using the
<a href="../api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a> method, followed by two separating characters: a colon
and a <space> character.
<p><dt>An optional printf-style message<dd>The supplied message <b>fmt</b>, if non-NULL, in which the
ANSI C X3.159-1989 (ANSI C) printf function specifies how subsequent arguments
are converted for output.
<p><dt>A separator<dd>Two separating characters: a colon and a <space> 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_c/env_strerror.html">db_strerror</a> method.
</dl>
</blockquote>
<p>This constructed error message is then handled as follows:
<p><blockquote>
<p>If an error callback function has been set (see <a href="../api_c/db_set_errcall.html">DB->set_errcall</a>
and <a href="../api_c/env_set_errcall.html">DB_ENV->set_errcall</a>), that function is called with two
arguments: any prefix string specified (see <a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a> and
<a href="../api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a>) and the error message.
<p>If a C library FILE * has been set (see <a href="../api_c/db_set_errfile.html">DB->set_errfile</a> and
<a href="../api_c/env_set_errfile.html">DB_ENV->set_errfile</a>), the error message is written to that output
stream.
<p>If none of these output options has been configured, the error message
is written to stderr, the standard
error output stream.</blockquote>
<p>The <a href="../api_c/env_err.html">DB_ENV->errx</a> and DB->errx methods perform identically to the
<a href="../api_c/env_err.html">DB_ENV->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_c/db_class.html">DB</a>
<h1>See Also</h1>
<a href="../api_c/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/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>
|