Imported Upstream version 5.3.21
[platform/upstream/libdb.git] / docs / csharp / html / M_BerkeleyDB_DatabaseEnvironment_IsTransactionApplied.htm
1 <html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp" xmlns:ddue="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:msxsl="urn:schemas-microsoft-com:xslt"><head><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8" /><META NAME="save" CONTENT="history" /><title>IsTransactionApplied Method </title><link rel="stylesheet" type="text/css" href="../styles/presentation.css" /><link rel="stylesheet" type="text/css" href="ms-help://Hx/HxRuntime/HxLink.css" /><script type="text/javascript" src="../scripts/EventUtilities.js"> </script><script type="text/javascript" src="../scripts/SplitScreen.js"> </script><script type="text/javascript" src="../scripts/Dropdown.js"> </script><script type="text/javascript" src="../scripts/script_manifold.js"> </script><script type="text/javascript" src="../scripts/script_feedBack.js"> </script><script type="text/javascript" src="../scripts/CheckboxMenu.js"> </script><script type="text/javascript" src="../scripts/CommonUtilities.js"> </script><meta name="container" content="BerkeleyDB" /><meta name="file" content="M_BerkeleyDB_DatabaseEnvironment_IsTransactionApplied" /><meta name="guid" content="M_BerkeleyDB_DatabaseEnvironment_IsTransactionApplied" /><xml><MSHelp:Attr Name="AssetID" Value="M:BerkeleyDB.DatabaseEnvironment.IsTransactionApplied(System.Byte[],System.UInt32)" /><MSHelp:TOCTitle Title="IsTransactionApplied Method " /><MSHelp:RLTitle Title="DatabaseEnvironment.IsTransactionApplied Method  (BerkeleyDB)" /><MSHelp:Keyword Index="A" Term="M:BerkeleyDB.DatabaseEnvironment.IsTransactionApplied(System.Byte[],System.UInt32)" /><MSHelp:Keyword Index="A" Term="frlrfBerkeleyDBDatabaseEnvironmentClassIsTransactionAppliedTopic" /><MSHelp:Keyword Index="K" Term="IsTransactionApplied method" /><MSHelp:Keyword Index="K" Term="DatabaseEnvironment.IsTransactionApplied method" /><MSHelp:Keyword Index="F" Term="IsTransactionApplied" /><MSHelp:Keyword Index="F" Term="DatabaseEnvironment.IsTransactionApplied" /><MSHelp:Keyword Index="F" Term="BerkeleyDB.DatabaseEnvironment.IsTransactionApplied" /><MSHelp:Attr Name="APIType" Value="Managed" /><MSHelp:Attr Name="APILocation" Value="libdb_dotnet53.dll" /><MSHelp:Attr Name="APIName" Value="BerkeleyDB.DatabaseEnvironment.IsTransactionApplied" /><MSHelp:Attr Name="DevLang" Value="CSharp" /><MSHelp:Attr Name="DevLang" Value="VB" /><MSHelp:Attr Name="DevLang" Value="C++" /><MSHelp:Attr Name="Locale" Value="en-us" /><MSHelp:Attr Name="TopicType" Value="kbSyntax" /><MSHelp:Attr Name="TopicType" Value="apiref" /><MSHelp:Attr Name="Abstract" Value="This method checks to see if a specified transaction has been replicated from the master of a replication group. It may be called by applications using either the Base API or the Replication Manager." /><MSHelp:Attr Name="AssemblyVersion" Value="5.3.21.0" /></xml></head><body><input type="hidden" id="userDataCache" class="userDataStyle" /><input type="hidden" id="hiddenScrollOffset" /><img id="collapseImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" title="Collapse image" /><img id="expandImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" title="Expand Image" /><img id="collapseAllImage" style="display:none; height:0; width:0;" src="../icons/collapse_all.gif" /><img id="expandAllImage" style="display:none; height:0; width:0;" src="../icons/expand_all.gif" /><img id="dropDownImage" style="display:none; height:0; width:0;" src="../icons/dropdown.gif" /><img id="dropDownHoverImage" style="display:none; height:0; width:0;" src="../icons/dropdownHover.gif" /><img id="copyImage" style="display:none; height:0; width:0;" src="../icons/copycode.gif" title="Copy image" /><img id="copyHoverImage" style="display:none; height:0; width:0;" src="../icons/copycodeHighlight.gif" title="CopyHover image" /><div id="header"><table id="topTable" cellspacing="0" cellpadding="0"><tr><td><span onclick="ExpandCollapseAll(toggleAllImage)" style="cursor:default;" onkeypress="ExpandCollapseAll_CheckKey(toggleAllImage, event)" tabindex="0"><img ID="toggleAllImage" class="toggleAll" src="../icons/collapse_all.gif" /> <label id="collapseAllLabel" for="toggleAllImage" style="display: none;">Collapse All</label><label id="expandAllLabel" for="toggleAllImage" style="display: none;">Expand All</label> </span><span>    </span><span id="devlangsDropdown" class="filter" tabindex="0"><img id="devlangsDropdownImage" src="../icons/dropdown.gif" /> <label id="devlangsMenuAllLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: All </nobr></label><label id="devlangsMenuMultipleLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Multiple </nobr></label><label id="devlangsMenuCSharpLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: C# </nobr></label><label id="devlangsMenuVisualBasicLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Visual Basic </nobr></label><label id="devlangsMenuManagedCPlusPlusLabel" for="devlangsDropdownImage" style="display: none;"><nobr>Code: Visual C++ </nobr></label></span></td></tr></table><div id="devlangsMenu"><input id="CSharpCheckbox" type="checkbox" data="CSharp,cs,'persist'" value="on" onClick="SetLanguage(this)" /><label class="checkboxLabel" for="CSharpCheckbox">C#</label><br /><input id="VisualBasicCheckbox" type="checkbox" data="VisualBasic,vb,'persist'" value="on" onClick="SetLanguage(this)" /><label class="checkboxLabel" for="VisualBasicCheckbox">Visual Basic</label><br /><input id="ManagedCPlusPlusCheckbox" type="checkbox" data="ManagedCPlusPlus,cpp,'persist'" value="on" onClick="SetLanguage(this)" /><label class="checkboxLabel" for="ManagedCPlusPlusCheckbox">Visual C++</label><br /></div><table id="bottomTable" cellpadding="0" cellspacing="0"><tr id="headerTableRow1"><td align="left"><span id="runningHeaderText">Berkeley DB .NET API Documentation</span></td></tr><tr id="headerTableRow2"><td align="left"><span id="nsrTitle">DatabaseEnvironment<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>IsTransactionApplied Method </span></td></tr><tr id="headerTableRow3"><td align="left"><a href="T_BerkeleyDB_DatabaseEnvironment.htm">DatabaseEnvironment Class</a>  <a href="#seeAlsoToggle" onclick="OpenSection(seeAlsoToggle)">See Also</a>  \r
2   <span id="headfeedbackarea" class="feedbackhead">\r
3       <a href="javascript:SubmitFeedback('','Berkeley DB .NET API Documentation','','','','%0\dYour%20feedback%20is%20used%20to%20improve%20the%20documentation%20and%20the%20product.%20Your%20e-mail%20address%20will%20not%20be%20used%20for%20any%20other%20purpose%20and%20is%20disposed%20of%20after%20the%20issue%20you%20report%20is%20resolved.%20%20While%20working%20to%20resolve%20the%20issue%20that%20you%20report,%20you%20may%20be%20contacted%20via%20e-mail%20to%20get%20further%20details%20or%20clarification%20on%20the%20feedback%20you%20sent.%20After%20the%20issue%20you%20report%20has%20been%20addressed,%20you%20may%20receive%20an%20e-mail%20to%20let%20you%20know%20that%20your%20feedback%20has%20been%20addressed.%0\A%0\d','Customer%20Feedback');">\r
4         \r
5         Send Feedback\r
6       </a>\r
7         </span>\r
8 </td></tr></table><table id="gradientTable"><tr><td class="nsrBottom" background="../icons/gradient.gif" /></tr></table></div><div id="mainSection"><div id="mainBody"><div id="allHistory" class="saveHistory" onsave="saveAll()" onload="loadAll()" /><span style="color: DarkGray"> </span><div class="summary">\r
9             This method checks to see if a specified transaction has been replicated from \r
10             the master of a replication group. It may be called by applications using either\r
11             the Base API or the Replication Manager.\r
12             </div><p />\r
13     <b>Namespace:</b> \r
14    <a href="N_BerkeleyDB.htm">BerkeleyDB</a><br />\r
15     <b>Assembly:</b>\r
16    <span sdata="assembly">libdb_dotnet53</span> (in libdb_dotnet53.dll) Version: 5.3.21.0<h1 class="heading"><span onclick="ExpandCollapse(syntaxToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(syntaxToggle, event)" tabindex="0"><img id="syntaxToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Syntax</span></h1><div id="syntaxSection" class="section" name="collapseableSection" style=""><div id="syntaxCodeBlocks" class="code"><span codeLanguage="CSharp"><table><tr><th>C#</th></tr><tr><td><pre xml:space="preserve"><span class="keyword">public</span> <a href="T_BerkeleyDB_TransactionAppliedStatus.htm">TransactionAppliedStatus</a> <span class="identifier">IsTransactionApplied</span>(\r
17         <a href="http://msdn2.microsoft.com/en-us/library/yyb1w04y" target="_blank">byte</a>[] <span class="parameter">token</span>,\r
18         <a href="http://msdn2.microsoft.com/en-us/library/ctys3981" target="_blank">uint</a> <span class="parameter">timeout</span>\r
19 )</pre></td></tr></table></span><span codeLanguage="VisualBasicDeclaration"><table><tr><th>Visual Basic (Declaration)</th></tr><tr><td><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Function</span> <span class="identifier">IsTransactionApplied</span> ( _\r
20         <span class="parameter">token</span> <span class="keyword">As</span> <a href="http://msdn2.microsoft.com/en-us/library/yyb1w04y" target="_blank">Byte</a>(), _\r
21         <span class="parameter">timeout</span> <span class="keyword">As</span> <a href="http://msdn2.microsoft.com/en-us/library/ctys3981" target="_blank">UInteger</a> _\r
22 ) <span class="keyword">As</span> <a href="T_BerkeleyDB_TransactionAppliedStatus.htm">TransactionAppliedStatus</a></pre></td></tr></table></span><span codeLanguage="ManagedCPlusPlus"><table><tr><th>Visual C++</th></tr><tr><td><pre xml:space="preserve"><span class="keyword">public</span>:\r
23 <a href="T_BerkeleyDB_TransactionAppliedStatus.htm">TransactionAppliedStatus</a> <span class="identifier">IsTransactionApplied</span>(\r
24         <span class="keyword">array</span>&lt;<a href="http://msdn2.microsoft.com/en-us/library/yyb1w04y" target="_blank">unsigned char</a>&gt;^ <span class="parameter">token</span>, \r
25         <a href="http://msdn2.microsoft.com/en-us/library/ctys3981" target="_blank">unsigned int</a> <span class="parameter">timeout</span>\r
26 )</pre></td></tr></table></span></div><div id="parameters"><h4 class="subHeading">Parameters</h4><dl paramName="token"><dt><span class="parameter">token</span></dt><dd>Type: <span class="languageSpecificText"><span class="cpp">array&lt;</span></span>\r
27             <a href="http://msdn2.microsoft.com/en-us/library/yyb1w04y" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Byte</a>\r
28           <span class="languageSpecificText"><span class="cpp">&gt;</span><span class="cs">[]</span><span class="vb">()</span><span class="nu">[]</span></span><br />\r
29             The commit token from a transaction previously written at a master\r
30             site in the replication group.  Commit tokens are retrieved using\r
31             the <a href="P_BerkeleyDB_Transaction_CommitToken.htm">CommitToken</a> method.\r
32             </dd></dl><dl paramName="timeout"><dt><span class="parameter">timeout</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/ctys3981" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>UInt32</a><br />\r
33             The maximum time to wait for the transaction to arrive by replication, expressed in \r
34             microseconds.  To check the status of the transaction without waiting, the timeout \r
35             may be specified as 0.\r
36             </dd></dl></div><h4 class="subHeading">Return Value</h4>\r
37             This method returns TransactionAppliedStatus.APPLIED to indicate that the specified \r
38             transaction has indeed been applied at the local site. TransactionAppliedStatus.TIMEOUT\r
39             will be returned if the specified transaction has not yet arrived at the calling site, \r
40             but can be expected to arrive soon. TransactionAppliedStatus.NOTFOUND will be returned \r
41             if the transaction has not been applied at the local site, and it can be determined that\r
42             the transaction has been rolled back due to a master takeover, and is therefore never \r
43             expected to arrive. TransactionAppliedStatus.EMPTY_TRANSACTION will be return if the specified\r
44             token was generated by a transaction that did not modify the database environment \r
45             (e.g., a read-only transaction).\r
46             </div><h1 class="heading"><span onclick="ExpandCollapse(seeAlsoToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(seeAlsoToggle, event)" tabindex="0"><img id="seeAlsoToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />See Also</span></h1><div id="seeAlsoSection" class="section" name="collapseableSection" style=""><div class="seeAlsoStyle"><a href="T_BerkeleyDB_DatabaseEnvironment.htm">DatabaseEnvironment Class</a></div><div class="seeAlsoStyle"><a href="N_BerkeleyDB.htm">BerkeleyDB Namespace</a></div></div></div><div id="footer"><div class="footerLine"><img width="100%" height="3px" src="../icons/footer.gif" title="Footer image" /></div><A NAME="feedback"></A><span id="fb" class="feedbackcss"> </span>\r
47 Report Feedback on this item in the Oracle Technology Network Forum <p />Copyright (c) 2008, 2012 Oracle. All rights reserved.</div></div></body></html>