docs/csharp/html/M_BerkeleyDB_RecnoDatabase_Open_3.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>Open Method (String, String, RecnoDatabaseConfig, Transaction)</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_RecnoDatabase_Open_3" /><meta name="guid" content="M_BerkeleyDB_RecnoDatabase_Open_3" /><xml><MSHelp:Attr Name="AssetID" Value="M:BerkeleyDB.RecnoDatabase.Open(System.String,System.String,BerkeleyDB.RecnoDatabaseConfig,BerkeleyDB.Transaction)" /><MSHelp:TOCTitle Title="Open Method (String, String, RecnoDatabaseConfig, Transaction)" /><MSHelp:RLTitle Title="RecnoDatabase.Open Method (String, String, RecnoDatabaseConfig, Transaction) (BerkeleyDB)" /><MSHelp:Keyword Index="A" Term="M:BerkeleyDB.RecnoDatabase.Open(System.String,System.String,BerkeleyDB.RecnoDatabaseConfig,BerkeleyDB.Transaction)" /><MSHelp:Attr Name="APIType" Value="Managed" /><MSHelp:Attr Name="APILocation" Value="libdb_dotnet53.dll" /><MSHelp:Attr Name="APIName" Value="BerkeleyDB.RecnoDatabase.Open" /><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="Instantiate a new RecnoDatabase object and open the database represented by and ." /><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">RecnoDatabase<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Open Method (String, String, RecnoDatabaseConfig, Transaction)</span></td></tr><tr id="headerTableRow3"><td align="left"><a href="T_BerkeleyDB_RecnoDatabase.htm">RecnoDatabase 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             Instantiate a new RecnoDatabase object and open the database\r
  10             represented by <span class="parameter">Filename</span> and\r
  11             <span class="parameter">DatabaseName</span>.\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> <span class="keyword">static</span> <a href="T_BerkeleyDB_RecnoDatabase.htm">RecnoDatabase</a> <span class="identifier">Open</span>(\r
  17         <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">string</a> <span class="parameter">Filename</span>,\r
  18         <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">string</a> <span class="parameter">DatabaseName</span>,\r
  19         <a href="T_BerkeleyDB_RecnoDatabaseConfig.htm">RecnoDatabaseConfig</a> <span class="parameter">cfg</span>,\r
  20         <a href="T_BerkeleyDB_Transaction.htm">Transaction</a> <span class="parameter">txn</span>\r
  21 )</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">Shared</span> <span class="keyword">Function</span> <span class="identifier">Open</span> ( _\r
  22         <span class="parameter">Filename</span> <span class="keyword">As</span> <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a>, _\r
  23         <span class="parameter">DatabaseName</span> <span class="keyword">As</span> <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a>, _\r
  24         <span class="parameter">cfg</span> <span class="keyword">As</span> <a href="T_BerkeleyDB_RecnoDatabaseConfig.htm">RecnoDatabaseConfig</a>, _\r
  25         <span class="parameter">txn</span> <span class="keyword">As</span> <a href="T_BerkeleyDB_Transaction.htm">Transaction</a> _\r
  26 ) <span class="keyword">As</span> <a href="T_BerkeleyDB_RecnoDatabase.htm">RecnoDatabase</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
  27 <span class="keyword">static</span> <a href="T_BerkeleyDB_RecnoDatabase.htm">RecnoDatabase</a>^ <span class="identifier">Open</span>(\r
  28         <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a>^ <span class="parameter">Filename</span>, \r
  29         <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a>^ <span class="parameter">DatabaseName</span>, \r
  30         <a href="T_BerkeleyDB_RecnoDatabaseConfig.htm">RecnoDatabaseConfig</a>^ <span class="parameter">cfg</span>, \r
  31         <a href="T_BerkeleyDB_Transaction.htm">Transaction</a>^ <span class="parameter">txn</span>\r
  32 )</pre></td></tr></table></span></div><div id="parameters"><h4 class="subHeading">Parameters</h4><dl paramName="Filename"><dt><span class="parameter">Filename</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>String</a><br />\r
  33             The name of an underlying file that will be used to back the\r
  34             database. In-memory databases never intended to be preserved on disk\r
  35             may be created by setting this parameter to null.\r
  36             </dd></dl><dl paramName="DatabaseName"><dt><span class="parameter">DatabaseName</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>String</a><br />\r
  37             This parameter allows applications to have multiple databases in a\r
  38             single file. Although no DatabaseName needs to be specified, it is\r
  39             an error to attempt to open a second database in a file that was not\r
  40             initially created using a database name.\r
  41             </dd></dl><dl paramName="cfg"><dt><span class="parameter">cfg</span></dt><dd>Type: <a href="T_BerkeleyDB_RecnoDatabaseConfig.htm">BerkeleyDB<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>RecnoDatabaseConfig</a><br />The database's configuration</dd></dl><dl paramName="txn"><dt><span class="parameter">txn</span></dt><dd>Type: <a href="T_BerkeleyDB_Transaction.htm">BerkeleyDB<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Transaction</a><br />\r
  42             If the operation is part of an application-specified transaction,\r
  43             <span class="parameter">txn</span> is a Transaction object returned from\r
  44             <a href="M_BerkeleyDB_DatabaseEnvironment_BeginTransaction.htm">BeginTransaction<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a>; if\r
  45             the operation is part of a Berkeley DB Concurrent Data Store group,\r
  46             <span class="parameter">txn</span> is a handle returned from\r
  47             <a href="M_BerkeleyDB_DatabaseEnvironment_BeginCDSGroup.htm">BeginCDSGroup<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a>; otherwise null.\r
  48             </dd></dl></div><h4 class="subHeading">Return Value</h4>A new, open database object</div><h1 class="heading"><span onclick="ExpandCollapse(remarksToggle)" style="cursor:default;" onkeypress="ExpandCollapse_CheckKey(remarksToggle, event)" tabindex="0"><img id="remarksToggle" class="toggle" name="toggleSwitch" src="../icons/collapse_all.gif" />Remarks</span></h1><div id="remarksSection" class="section" name="collapseableSection" style="">\r
  49         <p>\r
  50             If both <span class="parameter">Filename</span> and\r
  51             <span class="parameter">DatabaseName</span> are null, the database is strictly\r
  52             temporary and cannot be opened by any other thread of control, thus\r
  53             the database can only be accessed by sharing the single database \r
  54             object that created it, in circumstances where doing so is safe. If\r
  55             <span class="parameter">Filename</span> is null and\r
  56             <span class="parameter">DatabaseName</span> is non-null, the database can be\r
  57             opened by other threads of control and will be replicated to client\r
  58             sites in any replication group.\r
  59             </p>\r
  60         <p>\r
  61             If <span class="parameter">txn</span> is null, but\r
  62             <a href="F_BerkeleyDB_DatabaseConfig_AutoCommit.htm">AutoCommit</a> is set, the operation will\r
  63             be implicitly transaction protected. Note that transactionally\r
  64             protected operations on a datbase object requires the object itself\r
  65             be transactionally protected during its open. Also note that the\r
  66             transaction must be committed before the object is closed.\r
  67             </p>\r
  68       </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_RecnoDatabase.htm">RecnoDatabase Class</a></div><div class="seeAlsoStyle"><a href="Overload_BerkeleyDB_RecnoDatabase_Open.htm">Open Overload</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
  69 Report Feedback on this item in the Oracle Technology Network Forum <p />Copyright (c) 2008, 2012 Oracle. All rights reserved.</div></div></body></html>