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 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Db::set_errpfx()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="db.html" title="Chapter 2. The Db Handle" />
<link rel="prev" href="dbset_error_stream.html" title="Db::set_error_stream()" />
<link rel="next" href="dbset_feedback.html" title="Db::set_feedback()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Db::set_errpfx()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbset_error_stream.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2.
The Db Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbset_feedback.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="dbset_errpfx"></a>Db::set_errpfx()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
void Db::set_errpfx(const char *errpfx); </pre>
<p>
Set the prefix string that appears before error messages issued by
Berkeley DB.
</p>
<p>
The <code class="methodname">Db::set_errpfx()</code> and
<a class="xref" href="envset_errpfx.html" title="DbEnv::set_errpfx()">DbEnv::set_errpfx()</a>
methods do not copy the memory to which the <span class="bold"><strong>errpfx</strong></span> 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 class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handles opened
inside of Berkeley DB environments, calling the <code class="methodname">Db::set_errpfx()</code>
method affects the entire environment and is equivalent to calling the
<a class="xref" href="envset_errpfx.html" title="DbEnv::set_errpfx()">DbEnv::set_errpfx()</a>
method.
</p>
<p>
The <code class="methodname">Db::set_errpfx()</code> method configures operations performed using the
specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle, not
all operations performed on the underlying database.
</p>
<p>
The <code class="methodname">Db::set_errpfx()</code> method may be called at any time during the life
of the application.
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm287472"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idm305848"></a>errpfx</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>errpfx</strong></span> parameter is the
application-specified error prefix for additional error messages.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idm880648"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp329192"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbset_error_stream.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbset_feedback.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Db::set_error_stream() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Db::set_feedback()</td>
</tr>
</table>
</div>
</body>
</html>
|