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>DbTxn::set_name()</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="txn.html" title="Chapter 13. The DbTxn Handle" /> 11 <link rel="prev" href="txnrecover.html" title="DbEnv::txn_recover()" /> 12 <link rel="next" href="txnset_timeout.html" title="DbTxn::set_timeout()" /> 13 </head> 14 <body> 15 <div class="navheader"> 16 <table width="100%" summary="Navigation header"> 17 <tr> 18 <th colspan="3" align="center">DbTxn::set_name()</th> 19 </tr> 20 <tr> 21 <td width="20%" align="left"><a accesskey="p" href="txnrecover.html">Prev</a> </td> 22 <th width="60%" align="center">Chapter 13. 23 The DbTxn Handle 24 </th> 25 <td width="20%" align="right"> <a accesskey="n" href="txnset_timeout.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="txnset_name"></a>DbTxn::set_name()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db_cxx.h> 39 40int 41DbTxn::set_name(const char *name); </pre> 42 <p> 43 The <code class="methodname">DbTxn::set_name()</code> method associates the specified string with 44 the transaction. The string is returned by 45 <a class="xref" href="txnstat.html" title="DbEnv::txn_stat()">DbEnv::txn_stat()</a> and displayed 46 by <a class="xref" href="txnstat_print.html" title="DbEnv::txn_stat_print()">DbEnv::txn_stat_print()</a>. 47 </p> 48 <p> 49 If the database environment has been configured for logging and the 50 Berkeley DB library was configured with <a href="../../programmer_reference/build_unix_conf.html" class="olink">--enable-diagnostic</a>, 51 a debugging log record is written including the transaction ID and the 52 name. 53 </p> 54 <p> 55 The <code class="methodname">DbTxn::set_name()</code> method may be called at any time during the 56 life of the application. 57 </p> 58 <p> 59 The <code class="methodname">DbTxn::set_name()</code> <span> 60 61 <span> 62 method either returns a non-zero error value or throws an 63 exception that encapsulates a non-zero error value on 64 failure, and returns 0 on success. 65 </span> 66 </span> 67 </p> 68 <div class="sect2" lang="en" xml:lang="en"> 69 <div class="titlepage"> 70 <div> 71 <div> 72 <h3 class="title"><a id="id1715289"></a>Parameters</h3> 73 </div> 74 </div> 75 </div> 76 <div class="sect3" lang="en" xml:lang="en"> 77 <div class="titlepage"> 78 <div> 79 <div> 80 <h4 class="title"><a id="id1715155"></a>name</h4> 81 </div> 82 </div> 83 </div> 84 <p> 85 The <span class="bold"><strong>name</strong></span> parameter is the string to 86 associate with the transaction. 87 </p> 88 </div> 89 </div> 90 <div class="sect2" lang="en" xml:lang="en"> 91 <div class="titlepage"> 92 <div> 93 <div> 94 <h3 class="title"><a id="id1715558"></a>Class</h3> 95 </div> 96 </div> 97 </div> 98 <p> 99 <a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>, <a class="link" href="txn.html" title="Chapter 13. The DbTxn Handle">DbTxn</a> 100 </p> 101 </div> 102 <div class="sect2" lang="en" xml:lang="en"> 103 <div class="titlepage"> 104 <div> 105 <div> 106 <h3 class="title"><a id="id1715160"></a>See Also</h3> 107 </div> 108 </div> 109 </div> 110 <p> 111 <a class="xref" href="txn.html#txnlist" title="Transaction Subsystem and Related Methods">Transaction Subsystem and Related Methods</a> 112 </p> 113 </div> 114 </div> 115 <div class="navfooter"> 116 <hr /> 117 <table width="100%" summary="Navigation footer"> 118 <tr> 119 <td width="40%" align="left"><a accesskey="p" href="txnrecover.html">Prev</a> </td> 120 <td width="20%" align="center"> 121 <a accesskey="u" href="txn.html">Up</a> 122 </td> 123 <td width="40%" align="right"> <a accesskey="n" href="txnset_timeout.html">Next</a></td> 124 </tr> 125 <tr> 126 <td width="40%" align="left" valign="top">DbEnv::txn_recover() </td> 127 <td width="20%" align="center"> 128 <a accesskey="h" href="index.html">Home</a> 129 </td> 130 <td width="40%" align="right" valign="top"> DbTxn::set_timeout()</td> 131 </tr> 132 </table> 133 </div> 134 </body> 135</html> 136