1<!--$Id: db_set_errpfx.so,v 10.10 2002/08/18 21:15:55 bostic Exp $--> 2<!--$Id: env_set_errpfx.so,v 10.34 2006/02/10 22:54:59 bostic Exp $--> 3<!--Copyright (c) 1997,2008 Oracle. All rights reserved.--> 4<!--See the file LICENSE for redistribution information.--> 5<html> 6<head> 7<title>Berkeley DB: DB->set_errpfx</title> 8<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> 9<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> 10</head> 11<body bgcolor=white> 12<table width="100%"><tr valign=top> 13<td> 14<b>DB->set_errpfx</b> 15</td> 16<td align=right> 17<a href="/api_c/api_core.html"><img src="/images/api.gif" alt="API"></a> 18<a href="/ref/toc.html"><img src="/images/ref.gif" alt="Ref"></a></td> 19</tr></table> 20<hr size=1 noshade> 21<tt> 22<b><pre> 23#include <db.h> 24<p> 25void 26DB->set_errpfx(DB *db, const char *errpfx); 27<p> 28void DB->get_errpfx(DB *db, const char **errpfxp); 29</pre></b> 30<hr size=1 noshade> 31<b>Description: DB->set_errpfx</b> 32<p>Set the prefix string that appears before error messages issued by Berkeley DB.</p> 33<p>The DB->set_errpfx and <a href="/api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a> methods do not copy 34the memory to which the <b>errpfx</b> parameter refers; rather, they 35maintain a reference to it. Although this allows applications to modify 36the error message prefix at any time (without repeatedly calling the 37interfaces), it means the memory must be maintained until the handle is 38closed.</p> 39<p>For <a href="/api_c/db_class.html">DB</a> handles opened inside of Berkeley DB environments, calling the 40DB->set_errpfx method affects the entire environment and is equivalent to calling 41the <a href="/api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a> method.</p> 42<p>The DB->set_errpfx method configures operations performed using the specified 43<a href="/api_c/db_class.html">DB</a> handle, not all operations performed on the underlying 44database.</p> 45<p>The DB->set_errpfx method may be called at any time during the life of the 46application.</p> 47<b>Parameters</b> <br> 48 <b>errpfx</b><ul compact><li>The <b>errpfx</b> parameter is the application-specified error prefix 49for additional error messages.</ul> 50<br> 51<hr size=1 noshade> 52<b>Description: DB->get_errpfx</b> 53<p>The DB->get_errpfx method returns the error prefix.</p> 54<p>The DB->get_errpfx method may be called at any time during the life of the 55application.</p> 56<p>The DB->get_errpfx method 57returns a non-zero error value on failure 58and 0 on success. 59</p> 60<b>Parameters</b> <br> 61 <b>errpfxp</b><ul compact><li>The DB->get_errpfx method returns a reference to the 62error prefix in <b>errpfxp</b>.</ul> 63<br> 64<hr size=1 noshade> 65<br><b>Class</b> 66<a href="/api_c/db_class.html">DB</a> 67<br><b>See Also</b> 68<a href="/api_c/db_list.html">Databases and Related Methods</a> 69</tt> 70<table width="100%"><tr><td><br></td><td align=right> 71<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> 72</td></tr></table> 73<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 74</body> 75</html> 76
