| <html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><style type="text/css">.OH_CodeSnippetContainerTabLeftActive, .OH_CodeSnippetContainerTabLeft,.OH_CodeSnippetContainerTabLeftDisabled { }.OH_CodeSnippetContainerTabRightActive, .OH_CodeSnippetContainerTabRight,.OH_CodeSnippetContainerTabRightDisabled { }.OH_footer { }</style><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>RollingFileAppender.RollOverRenameFiles Method </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="RollOverRenameFiles method" /><meta name="System.Keywords" content="RollingFileAppender.RollOverRenameFiles method" /><meta name="Microsoft.Help.F1" content="log4net.Appender.RollingFileAppender.RollOverRenameFiles" /><meta name="Microsoft.Help.Id" content="M:log4net.Appender.RollingFileAppender.RollOverRenameFiles(System.String)" /><meta name="Description" content="Implements file roll." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="log4net.Appender" /><meta name="file" content="M_log4net_Appender_RollingFileAppender_RollOverRenameFiles" /><meta name="guid" content="M_log4net_Appender_RollingFileAppender_RollOverRenameFiles" /></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="OH_outerDiv"><div class="OH_outerContent"><table class="TitleTable"><tr><td class="OH_tdTitleColumn">RollingFileAppender<span id="LST372F2470_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST372F2470_0?cpp=::|nu=.");</script>RollOverRenameFiles Method </td><td class="OH_tdRunningTitleColumn">Apache log4net™ SDK Documentation</td></tr></table><div id="mainSection"><div id="mainBody"><span class="introStyle"></span><div class="summary"> |
| Implements file roll. |
| </div><p> </p><strong>Namespace:</strong> <a href="N_log4net_Appender.htm">log4net.Appender</a><br /><strong>Assembly:</strong> log4net (in log4net.dll) Version: 2.0.6.0-.NET 4.0<div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Syntax</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><div class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs"><div class="OH_CodeSnippetContainerTabLeft" id="ID0EDCA_tabimgleft"> </div><div id="ID0EDCA_tab1" class="OH_CodeSnippetContainerTabFirst"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cs','1','4');return false;">C#</a></div><div id="ID0EDCA_tab2" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','vb','2','4');return false;">VB</a></div><div id="ID0EDCA_tab3" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','cpp','3','4');return false;">C++</a></div><div id="ID0EDCA_tab4" class="OH_CodeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID0EDCA','fs','4','4');return false;">F#</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0EDCA_tabimgright"> </div></div><div class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0EDCA_copyCode" href="#" onclick="javascript:CopyToClipboard('ID0EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID0EDCA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">protected</span> <span class="keyword">void</span> <span class="identifier">RollOverRenameFiles</span>( |
| <span class="identifier">string</span> <span class="parameter">baseFileName</span> |
| )</pre></div><div id="ID0EDCA_code_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Protected</span> <span class="keyword">Sub</span> <span class="identifier">RollOverRenameFiles</span> ( |
| <span class="parameter">baseFileName</span> <span class="keyword">As</span> <span class="identifier">String</span> |
| )</pre></div><div id="ID0EDCA_code_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">protected</span>: |
| <span class="keyword">void</span> <span class="identifier">RollOverRenameFiles</span>( |
| <span class="identifier">String</span>^ <span class="parameter">baseFileName</span> |
| )</pre></div><div id="ID0EDCA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">member</span> <span class="identifier">RollOverRenameFiles</span> : |
| <span class="parameter">baseFileName</span> : <span class="identifier">string</span> <span class="keyword">-></span> <span class="keyword">unit</span> |
| </pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><h4 class="subHeading">Parameters</h4><dl><dt><span class="parameter">baseFileName</span></dt><dd>Type: <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">System<span id="LST372F2470_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST372F2470_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>String</a><br />the base name to rename</dd></dl><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Remarks</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><p> |
| If the maximum number of size based backups is reached |
| (<span class="code">curSizeRollBackups == maxSizeRollBackups</span>) then the oldest |
| file is deleted -- its index determined by the sign of countDirection. |
| If <span class="code">countDirection</span> < 0, then files |
| {<span class="code">File.1</span>, ..., <span class="code">File.curSizeRollBackups -1</span>} |
| are renamed to {<span class="code">File.2</span>, ..., |
| <span class="code">File.curSizeRollBackups</span>}. |
| </p><p> |
| If <span class="code">maxSizeRollBackups</span> is equal to zero, then the |
| <span class="code">File</span> is truncated with no backup files created. |
| </p><p> |
| If <span class="code">maxSizeRollBackups</span> < 0, then <span class="code">File</span> is |
| renamed if needed and no files are deleted. |
| </p><p> |
| This is called by <a href="M_log4net_Appender_RollingFileAppender_RollOverSize.htm">RollOverSize<span id="LST372F2470_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST372F2470_2?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a> to rename the files. |
| </p><div class="OH_CollapsibleAreaRegion" id="seeAlsoSection"><div class="OH_regiontitle">See Also</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="T_log4net_Appender_RollingFileAppender.htm">RollingFileAppender Class</a></div><div class="seeAlsoStyle"><a href="N_log4net_Appender.htm">log4net.Appender Namespace</a></div></div></div></div></div><div id="OH_footer" class="OH_footer">Apache log4net, Apache and log4net are trademarks of The Apache Software Foundation.<p><a href="http://logging.apache.org/log4net/" target="_blank">Copyright 2004-2016 The Apache Software Foundation</a></p><div class="OH_feedbacklink">Send comments on this topic to |
| <a id="HT_MailLink" href="mailto:http%3A%2F%2Flogging.apache.org%2Flog4net%2Fmail-lists.html?Subject=Apache log4net™ SDK Documentation">http://logging.apache.org/log4net/mail-lists.html</a></div><script type="text/javascript"> |
| var HT_mailLink = document.getElementById("HT_MailLink"); |
| var HT_mailLinkText = HT_mailLink.innerHTML; |
| HT_mailLink.href += ": " + document.title + "\u0026body=" + encodeURIComponent("Your feedback is used to improve the documentation and the product. Your e-mail address will not be used for any other purpose and is disposed of after the issue you report is resolved. While working to resolve the issue that you report, you may be contacted via e-mail to get further details or clarification on the feedback you sent. After the issue you report has been addressed, you may receive an e-mail to let you know that your feedback has been addressed."); |
| HT_mailLink.innerHTML = HT_mailLinkText; |
| </script> </div></body></html> |
