docs/csharp/html/M_BerkeleyDB_DatabaseEnvironment_ArchivableLogFiles.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>ArchivableLogFiles 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_ArchivableLogFiles" /><meta name="guid" content="M_BerkeleyDB_DatabaseEnvironment_ArchivableLogFiles" /><xml><MSHelp:Attr Name="AssetID" Value="M:BerkeleyDB.DatabaseEnvironment.ArchivableLogFiles(System.Boolean)" /><MSHelp:TOCTitle Title="ArchivableLogFiles Method " /><MSHelp:RLTitle Title="DatabaseEnvironment.ArchivableLogFiles Method  (BerkeleyDB)" /><MSHelp:Keyword Index="A" Term="M:BerkeleyDB.DatabaseEnvironment.ArchivableLogFiles(System.Boolean)" /><MSHelp:Keyword Index="A" Term="frlrfBerkeleyDBDatabaseEnvironmentClassArchivableLogFilesTopic" /><MSHelp:Keyword Index="K" Term="ArchivableLogFiles method" /><MSHelp:Keyword Index="K" Term="DatabaseEnvironment.ArchivableLogFiles method" /><MSHelp:Keyword Index="F" Term="ArchivableLogFiles" /><MSHelp:Keyword Index="F" Term="DatabaseEnvironment.ArchivableLogFiles" /><MSHelp:Keyword Index="F" Term="BerkeleyDB.DatabaseEnvironment.ArchivableLogFiles" /><MSHelp:Attr Name="APIType" Value="Managed" /><MSHelp:Attr Name="APILocation" Value="libdb_dotnet53.dll" /><MSHelp:Attr Name="APIName" Value="BerkeleyDB.DatabaseEnvironment.ArchivableLogFiles" /><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="The names of all of the log files that are no longer in use (for example, that are no longer involved in active transactions), and that may safely be archived for catastrophic recovery and then rem ..." /><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>ArchivableLogFiles 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             The names of all of the log files that are no longer in use (for\r
  10             example, that are no longer involved in active transactions), and\r
  11             that may safely be archived for catastrophic recovery and then\r
  12             removed from the system.\r
  13             </div><p />\r
  14     <b>Namespace:</b> \r
  15    <a href="N_BerkeleyDB.htm">BerkeleyDB</a><br />\r
  16     <b>Assembly:</b>\r
  17    <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="http://msdn2.microsoft.com/en-us/library/6sh2ey19" target="_blank">List</a>&lt;<a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">string</a>&gt; <span class="identifier">ArchivableLogFiles</span>(\r
  18         <a href="http://msdn2.microsoft.com/en-us/library/a28wyd50" target="_blank">bool</a> <span class="parameter">AbsolutePaths</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">ArchivableLogFiles</span> ( _\r
  20         <span class="parameter">AbsolutePaths</span> <span class="keyword">As</span> <a href="http://msdn2.microsoft.com/en-us/library/a28wyd50" target="_blank">Boolean</a> _\r
  21 ) <span class="keyword">As</span> <a href="http://msdn2.microsoft.com/en-us/library/6sh2ey19" target="_blank">List</a>(<span class="keyword">Of</span> <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</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
  22 <a href="http://msdn2.microsoft.com/en-us/library/6sh2ey19" target="_blank">List</a>&lt;<a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a>^&gt;^ <span class="identifier">ArchivableLogFiles</span>(\r
  23         <a href="http://msdn2.microsoft.com/en-us/library/a28wyd50" target="_blank">bool</a> <span class="parameter">AbsolutePaths</span>\r
  24 )</pre></td></tr></table></span></div><div id="parameters"><h4 class="subHeading">Parameters</h4><dl paramName="AbsolutePaths"><dt><span class="parameter">AbsolutePaths</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/a28wyd50" target="_blank">System<span class="languageSpecificText"><span class="cs">.</span><span class="vb">.</span><span class="cpp">::</span><span class="nu">.</span></span>Boolean</a><br />\r
  25             If true, all pathnames are returned as absolute pathnames, instead \r
  26             of relative to the database home directory.\r
  27             </dd></dl></div><h4 class="subHeading">Return Value</h4>\r
  28             The names of all of the log files that are no longer in use\r
  29             </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
  30         <p>\r
  31             The Berkeley DB interfaces to the database environment logging\r
  32             subsystem (for example, <a href="M_BerkeleyDB_Transaction_Abort.htm">Abort<span class="languageSpecificText"><span class="cs">()</span><span class="cpp">()</span><span class="nu">()</span></span></a>) may\r
  33             allocate log cursors and have open file descriptors for log files\r
  34             as well. On operating systems where filesystem related system calls\r
  35             (for example, rename and unlink on Windows/NT) can fail if a process\r
  36             has an open file descriptor for the affected file, attempting to\r
  37             move or remove the log files listed by ArchivableLogFiles may fail.\r
  38             All Berkeley DB internal use of log cursors operates on active log\r
  39             files only and furthermore, is short-lived in nature. So, an\r
  40             application seeing such a failure should be restructured to retry\r
  41             the operation until it succeeds. (Although this is not likely to be\r
  42             necessary; it is hard to imagine a reason to move or rename a log\r
  43             file in which transactions are being logged or aborted.)\r
  44             </p>\r
  45         <p>\r
  46             When Replication Manager is in use, log archiving will be performed\r
  47             in a replication group-aware manner such that the log file status of\r
  48             other sites in the group will be considered to determine if a log\r
  49             file could be in use. \r
  50             </p>\r
  51         <p>\r
  52             See the db_archive utility for more information on database archival\r
  53             procedures.\r
  54             </p>\r
  55       </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
  56 Report Feedback on this item in the Oracle Technology Network Forum <p />Copyright (c) 2008, 2012 Oracle. All rights reserved.</div></div></body></html>