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>DB_TXN->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 12. The DB_TXN Handle" /> 11 <link rel="prev" href="txnrecover.html" title="DB_ENV->txn_recover()" /> 12 <link rel="next" href="txnset_timeout.html" title="DB_TXN->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">DB_TXN->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 12. 23 The DB_TXN 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>DB_TXN->set_name()</h2> 35 </div> 36 </div> 37 </div> 38 <pre class="programlisting">#include <db.h> 39 40int 41DB_TXN->set_name(DB_TXN *txn, const char *name); </pre> 42 <p> 43 The <code class="methodname">DB_TXN->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="DB_ENV->txn_stat()">DB_ENV->txn_stat()</a> and displayed 46 by <a class="xref" href="txnstat_print.html" title="DB_ENV->txn_stat_print()">DB_ENV->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">DB_TXN->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">DB_TXN->set_name()</code> <span> 60 <span> 61 method returns a non-zero error value on failure and 0 on success. 62 </span> 63 64 </span> 65 </p> 66 <div class="sect2" lang="en" xml:lang="en"> 67 <div class="titlepage"> 68 <div> 69 <div> 70 <h3 class="title"><a id="id1710074"></a>Parameters</h3> 71 </div> 72 </div> 73 </div> 74 <div class="sect3" lang="en" xml:lang="en"> 75 <div class="titlepage"> 76 <div> 77 <div> 78 <h4 class="title"><a id="id1710077"></a>name</h4> 79 </div> 80 </div> 81 </div> 82 <p> 83 The <span class="bold"><strong>name</strong></span> parameter is the string to 84 associate with the transaction. 85 </p> 86 </div> 87 </div> 88 <div class="sect2" lang="en" xml:lang="en"> 89 <div class="titlepage"> 90 <div> 91 <div> 92 <h3 class="title"><a id="id1710392"></a>Class</h3> 93 </div> 94 </div> 95 </div> 96 <p> 97 <a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a>, <a class="link" href="txn.html" title="Chapter 12. The DB_TXN Handle">DB_TXN</a> 98 </p> 99 </div> 100 <div class="sect2" lang="en" xml:lang="en"> 101 <div class="titlepage"> 102 <div> 103 <div> 104 <h3 class="title"><a id="id1709993"></a>See Also</h3> 105 </div> 106 </div> 107 </div> 108 <p> 109 <a class="xref" href="txn.html#txnlist" title="Transaction Subsystem and Related Methods">Transaction Subsystem and Related Methods</a> 110 </p> 111 </div> 112 </div> 113 <div class="navfooter"> 114 <hr /> 115 <table width="100%" summary="Navigation footer"> 116 <tr> 117 <td width="40%" align="left"><a accesskey="p" href="txnrecover.html">Prev</a> </td> 118 <td width="20%" align="center"> 119 <a accesskey="u" href="txn.html">Up</a> 120 </td> 121 <td width="40%" align="right"> <a accesskey="n" href="txnset_timeout.html">Next</a></td> 122 </tr> 123 <tr> 124 <td width="40%" align="left" valign="top">DB_ENV->txn_recover() </td> 125 <td width="20%" align="center"> 126 <a accesskey="h" href="index.html">Home</a> 127 </td> 128 <td width="40%" align="right" valign="top"> DB_TXN->set_timeout()</td> 129 </tr> 130 </table> 131 </div> 132 </body> 133</html> 134