blob: 92621c046129d171a88d1c350a81682a05e12eae [file] [log] [blame]
<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>FileAppender.LockingModel Property </title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="LockingModel property" /><meta name="System.Keywords" content="FileAppender.LockingModel property" /><meta name="Microsoft.Help.F1" content="log4net.Appender.FileAppender.LockingModel" /><meta name="Microsoft.Help.F1" content="log4net.Appender.FileAppender.get_LockingModel" /><meta name="Microsoft.Help.F1" content="log4net.Appender.FileAppender.set_LockingModel" /><meta name="Microsoft.Help.Id" content="P:log4net.Appender.FileAppender.LockingModel" /><meta name="Description" content="Gets or sets the used to handle locking of the file." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="log4net.Appender" /><meta name="file" content="P_log4net_Appender_FileAppender_LockingModel" /><meta name="guid" content="P_log4net_Appender_FileAppender_LockingModel" /></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">FileAppender<span id="LSTF14A1505_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_0?cpp=::|nu=.");</script>LockingModel Property </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">
Gets or sets the <span class="selflink">LockingModel</span> used to handle locking of the file.
</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.8.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">public</span> <span class="identifier">FileAppender<span id="LSTF14A1505_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</span> <span class="identifier">LockingModel</span> { <span class="keyword">get</span>; <span class="keyword">set</span>; }</pre></div><div id="ID0EDCA_code_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Property</span> <span class="identifier">LockingModel</span> <span class="keyword">As</span> <span class="identifier">FileAppender<span id="LSTF14A1505_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</span>
<span class="keyword">Get</span>
<span class="keyword">Set</span></pre></div><div id="ID0EDCA_code_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span>:
<span class="keyword">property</span> <span class="identifier">FileAppender<span id="LSTF14A1505_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</span>^ <span class="identifier">LockingModel</span> {
<span class="identifier">FileAppender<span id="LSTF14A1505_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</span>^ <span class="keyword">get</span> ();
<span class="keyword">void</span> <span class="keyword">set</span> (<span class="identifier">FileAppender<span id="LSTF14A1505_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</span>^ <span class="parameter">value</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">LockingModel</span> : <span class="identifier">FileAppender<span id="LSTF14A1505_6"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_6?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</span> <span class="keyword">with</span> <span class="keyword">get</span>, <span class="keyword">set</span>
</pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><h4 class="subHeading">Property Value</h4>Type: <a href="T_log4net_Appender_FileAppender_LockingModelBase.htm">FileAppender<span id="LSTF14A1505_7"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_7?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</a><br />
The <span class="selflink">LockingModel</span> used to lock the file.
<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>
Gets or sets the <span class="selflink">LockingModel</span> used to handle locking of the file.
</p><p>
There are three built in locking models, <a href="T_log4net_Appender_FileAppender_ExclusiveLock.htm">FileAppender<span id="LSTF14A1505_8"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_8?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ExclusiveLock</a>, <a href="T_log4net_Appender_FileAppender_MinimalLock.htm">FileAppender<span id="LSTF14A1505_9"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_9?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>MinimalLock</a> and <a href="T_log4net_Appender_FileAppender_InterProcessLock.htm">FileAppender<span id="LSTF14A1505_10"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_10?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>InterProcessLock</a> .
The first locks the file from the start of logging to the end, the
second locks only for the minimal amount of time when logging each message
and the last synchronizes processes using a named system wide Mutex.
</p><p>
The default locking model is the <a href="T_log4net_Appender_FileAppender_ExclusiveLock.htm">FileAppender<span id="LSTF14A1505_11"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTF14A1505_11?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ExclusiveLock</a>.
</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_FileAppender.htm">FileAppender 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-2017 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>