libdb/docs/api_reference/STL/stldbstl_global_functionsbegin_txn.html

139 lines
5.5 KiB
HTML
Raw Normal View History

2011-09-13 17:44:24 +00:00
<?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>begin_txn</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++ Standard Template Library API Reference" />
<link rel="up" href="dbstl_global_functions.html" title="Chapter 1.  Dbstl Global Public Functions" />
<link rel="prev" href="stldbstl_global_functionsclose_all_db_envs.html" title="close_all_db_envs" />
<link rel="next" href="stldbstl_global_functionscommit_txn.html" title="commit_txn" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">begin_txn</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="stldbstl_global_functionsclose_all_db_envs.html">Prev</a> </td>
<th width="60%" align="center">Chapter 1. 
Dbstl Global Public Functions </th>
<td width="20%" align="right"> <a accesskey="n" href="stldbstl_global_functionscommit_txn.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="stldbstl_global_functionsbegin_txn"></a>begin_txn</h2>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="stldbstl_global_functionsbegin_txn_details"></a>Function Details</h3>
</div>
</div>
</div>
<pre class="programlisting">
DbTxn* begin_txn(u_int32_t flags,
DbEnv *env)
</pre>
<p>Begin a new transaction from the specified environment "env". </p>
<p>This function is called by dbstl user to begin an external transaction. The "flags" parameter is passed to DbEnv::txn_begin(). If a transaction created from the same database environment already exists and is unresolved, the new transaction is started as a child transaction of that transaction, and thus you can't specify the parent transaction. </p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h4 class="title"><a id="id3592869"></a>Parameters</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3593007"></a>flags</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>It is set to DbEnv::txn_begin() function. </p>
</div>
<div class="sect4" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h5 class="title"><a id="id3593038"></a>env</h5>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The environment to start a transaction from. </p>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h4 class="title"><a id="id3592991"></a>Return Value</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>The newly created transaction. </p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h3 class="title"><a id="id3592973"></a>Group: Transaction control global functions.</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>dbstl transaction API.</p>
<p>You should call these API rather than DB C/C++ API to use Berkeley DB transaction features. </p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h3 class="title"><a id="id3592952"></a>Class</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
<a class="link" href="dbstl_global_functions.html" title="Chapter 1.  Dbstl Global Public Functions">dbstl_global_functions</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="stldbstl_global_functionsclose_all_db_envs.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="dbstl_global_functions.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="stldbstl_global_functionscommit_txn.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">close_all_db_envs </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> commit_txn</td>
</tr>
</table>
</div>
</body>
</html>