1<?xml version="1.0" encoding="UTF-8" standalone="no"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 6 <title>DbEnv::set_errpfx()</title> 7 <link rel="stylesheet" href="apiReference.css" type="text/css" /> 8 <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /> 9 <link rel="start" href="index.html" title="Berkeley DB C++ API Reference" /> 10 <link rel="up" href="env.html" title="Chapter 5. The DbEnv Handle" /> 11 <link rel="prev" href="envset_error_stream.html" title="DbEnv::set_error_stream()" /> 12 <link rel="next" href="envset_feedback.html" title="DbEnv::set_feedback()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbEnv::set_errpfx()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="envset_error_stream.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 5. 23 The DbEnv Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="envset_feedback.html">Next</a></td> 26 </tr> 27 </table> 28 <hr /> 29 </div> 30 <div class="sect1" lang="en" xml:lang="en"> 31 <div class="titlepage"> 32 <div> 33 <div> 34 <h2 class="title" style="clear: both"><a id="envset_errpfx"></a>DbEnv::set_errpfx()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40void 41DbEnv::set_errpfx(const char *errpfx); </pre> 42 <p> 43 Set the prefix string that appears before error messages issued by 44 Berkeley DB. 45 </p> 46 <p> 47 The <a class="xref" href="dbset_errpfx.html" title="Db::set_errpfx()">Db::set_errpfx()</a> 48 and <code class="methodname">DbEnv::set_errpfx()</code> methods do not copy the memory to which the 49 <span class="bold"><strong>errpfx</strong></span> parameter refers; rather, they 50 maintain a reference to it. Although this allows applications to 51 modify the error message prefix at any time (without repeatedly 52 calling the interfaces), it means the memory must be maintained until 53 the handle is closed. 54 </p> 55 <p> 56 The <code class="methodname">DbEnv::set_errpfx()</code> method configures operations performed using 57 the specified <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> 58 handle, not all operations performed on the underlying database 59 environment. 60 </p> 61 <p> 62 The <code class="methodname">DbEnv::set_errpfx()</code> method may be called at any time during the 63 life of the application. 64 </p> 65 <div class="sect2" lang="en" xml:lang="en"> 66 <div class="titlepage"> 67 <div> 68 <div> 69 <h3 class="title"><a id="id1671625"></a>Parameters</h3> 70 </div> 71 </div> 72 </div> 73 <div class="sect3" lang="en" xml:lang="en"> 74 <div class="titlepage"> 75 <div> 76 <div> 77 <h4 class="title"><a id="id1671646"></a>errpfx</h4> 78 </div> 79 </div> 80 </div> 81 <p> 82 The <span class="bold"><strong>errpfx</strong></span> parameter is the 83 application-specified error prefix for additional error messages. 84 </p> 85 </div> 86 </div> 87 <div class="sect2" lang="en" xml:lang="en"> 88 <div class="titlepage"> 89 <div> 90 <div> 91 <h3 class="title"><a id="id1671791"></a>Class</h3> 92 </div> 93 </div> 94 </div> 95 <p> 96 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> 97 </p> 98 </div> 99 <div class="sect2" lang="en" xml:lang="en"> 100 <div class="titlepage"> 101 <div> 102 <div> 103 <h3 class="title"><a id="id1671626"></a>See Also</h3> 104 </div> 105 </div> 106 </div> 107 <p> 108 <a class="xref" href="env.html#envlist" title="Database Environments and Related Methods">Database Environments and Related Methods</a> 109 </p> 110 </div> 111 </div> 112 <div class="navfooter"> 113 <hr /> 114 <table width="100%" summary="Navigation footer"> 115 <tr> 116 <td width="40%" align="left"><a accesskey="p" href="envset_error_stream.html">Prev</a> </td> 117 <td width="20%" align="center"> 118 <a accesskey="u" href="env.html">Up</a> 119 </td> 120 <td width="40%" align="right"> <a accesskey="n" href="envset_feedback.html">Next</a></td> 121 </tr> 122 <tr> 123 <td width="40%" align="left" valign="top">DbEnv::set_error_stream() </td> 124 <td width="20%" align="center"> 125 <a accesskey="h" href="index.html">Home</a> 126 </td> 127 <td width="40%" align="right" valign="top"> DbEnv::set_feedback()</td> 128 </tr> 129 </table> 130 </div> 131 </body> 132</html> 133