db_set_errpfx.html [plain text]
<!--$Id: db_set_errpfx.so,v 10.10 2002/08/18 21:15:55 bostic Exp $-->
<!--$Id: env_set_errpfx.so,v 10.34 2006/02/10 22:54:59 bostic Exp $-->
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB->set_errpfx</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>
<b>DB->set_errpfx</b>
</td>
<td align=right>
<a href="../api_c/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>
<b><pre>
#include <db.h>
<p>
void
DB->set_errpfx(DB *db, const char *errpfx);
<p>
void DB->get_errpfx(DB *db, const char **errpfxp);
</pre></b>
<hr size=1 noshade>
<b>Description: DB->set_errpfx</b>
<p>Set the prefix string that appears before error messages issued by Berkeley DB.</p>
<p>The DB->set_errpfx and <a href="../api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a> methods do not copy
the memory to which the <b>errpfx</b> parameter refers; rather, they
maintain a reference to it. Although this allows applications to modify
the error message prefix at any time (without repeatedly calling the
interfaces), it means the memory must be maintained until the handle is
closed.</p>
<p>For <a href="../api_c/db_class.html">DB</a> handles opened inside of Berkeley DB environments, calling the
DB->set_errpfx method affects the entire environment and is equivalent to calling
the <a href="../api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a> method.</p>
<p>The DB->set_errpfx method configures operations performed using the specified
<a href="../api_c/db_class.html">DB</a> handle, not all operations performed on the underlying
database.</p>
<p>The DB->set_errpfx method may be called at any time during the life of the
application.</p>
<b>Parameters</b> <br>
<b>errpfx</b><ul compact><li>The <b>errpfx</b> parameter is the application-specified error prefix
for additional error messages.</ul>
<br>
<hr size=1 noshade>
<b>Description: DB->get_errpfx</b>
<p>The DB->get_errpfx method returns the error prefix.</p>
<p>The DB->get_errpfx method may be called at any time during the life of the
application.</p>
<p>The DB->get_errpfx method
returns a non-zero error value on failure
and 0 on success.
</p>
<b>Parameters</b> <br>
<b>errpfxp</b><ul compact><li>The DB->get_errpfx method returns a reference to the
error prefix in <b>errpfxp</b>.</ul>
<br>
<hr size=1 noshade>
<br><b>Class</b>
<a href="../api_c/db_class.html">DB</a>
<br><b>See Also</b>
<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/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>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
</body>
</html>