blob: 61660642681ff19d2eb487b9da42a671c005f944 [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.InterProcessLock Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="FileAppender.InterProcessLock class" /><meta name="System.Keywords" content="log4net.Appender.FileAppender.InterProcessLock class" /><meta name="System.Keywords" content="FileAppender.InterProcessLock class, about FileAppender.InterProcessLock class" /><meta name="Microsoft.Help.F1" content="log4net.Appender.FileAppender.InterProcessLock" /><meta name="Microsoft.Help.Id" content="T:log4net.Appender.FileAppender.InterProcessLock" /><meta name="Description" content="Provides cross-process file locking." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="log4net.Appender" /><meta name="file" content="T_log4net_Appender_FileAppender_InterProcessLock" /><meta name="guid" content="T_log4net_Appender_FileAppender_InterProcessLock" /></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="LST588ACAFD_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_0?cpp=::|nu=.");</script>InterProcessLock Class</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">
Provides cross-process file locking.
</div><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Inheritance Hierarchy</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="LST588ACAFD_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="T_log4net_Appender_FileAppender_LockingModelBase.htm">log4net.Appender<span id="LST588ACAFD_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>FileAppender<span id="LST588ACAFD_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</a><br />    <span class="selflink">log4net.Appender<span id="LST588ACAFD_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>FileAppender<span id="LST588ACAFD_5"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_5?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>InterProcessLock</span><br /><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">public</span> <span class="keyword">class</span> <span class="identifier">InterProcessLock</span> : <span class="identifier">FileAppender<span id="LST588ACAFD_6"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_6?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</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">Class</span> <span class="identifier">InterProcessLock</span>
<span class="keyword">Inherits</span> <span class="identifier">FileAppender<span id="LST588ACAFD_7"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_7?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</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">ref class</span> <span class="identifier">InterProcessLock</span> : <span class="keyword">public</span> <span class="identifier">FileAppender<span id="LST588ACAFD_8"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_8?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</span></pre></div><div id="ID0EDCA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">InterProcessLock</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">FileAppender<span id="LST588ACAFD_9"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_9?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><p>The <span class="selflink">FileAppender<span id="LST588ACAFD_10"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_10?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>InterProcessLock</span> type exposes the following members.</p><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Constructors</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_FileAppender_InterProcessLock__ctor.htm">FileAppender<span id="LST588ACAFD_11"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_11?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>InterProcessLock</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">FileAppender<span id="LST588ACAFD_12"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_12?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>InterProcessLock</span> class</div></td></tr></table><a href="#mainBody">Top</a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Properties</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Appender_FileAppender_LockingModelBase_CurrentAppender.htm">CurrentAppender</a></td><td><div class="summary">
Gets or sets the <a href="T_log4net_Appender_FileAppender.htm">FileAppender</a> for this LockingModel
</div> (Inherited from <a href="T_log4net_Appender_FileAppender_LockingModelBase.htm">FileAppender<span id="LST588ACAFD_13"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_13?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</a>.)</td></tr></table><a href="#mainBody">Top</a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Methods</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><table id="memberList" class="members"><tr><th class="ps_iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_FileAppender_InterProcessLock_AcquireLock.htm">AcquireLock</a></td><td><div class="summary">
Acquire the lock on the file
</div> (Overrides <a href="M_log4net_Appender_FileAppender_LockingModelBase_AcquireLock.htm">FileAppender<span id="LST588ACAFD_14"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_14?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase<span id="LST588ACAFD_15"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_15?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>AcquireLock<span id="LST588ACAFD_16"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_16?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_FileAppender_InterProcessLock_ActivateOptions.htm">ActivateOptions</a></td><td><div class="summary">
Initializes all resources used by this locking model.
</div> (Overrides <a href="M_log4net_Appender_FileAppender_LockingModelBase_ActivateOptions.htm">FileAppender<span id="LST588ACAFD_17"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_17?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase<span id="LST588ACAFD_18"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_18?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ActivateOptions<span id="LST588ACAFD_19"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_19?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_FileAppender_InterProcessLock_CloseFile.htm">CloseFile</a></td><td><div class="summary">
Close the file
</div> (Overrides <a href="M_log4net_Appender_FileAppender_LockingModelBase_CloseFile.htm">FileAppender<span id="LST588ACAFD_20"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_20?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase<span id="LST588ACAFD_21"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_21?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>CloseFile<span id="LST588ACAFD_22"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_22?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_FileAppender_LockingModelBase_CloseStream.htm">CloseStream</a></td><td><div class="summary">
Helper method to close <span class="parameter">stream</span> under CurrentAppender's SecurityContext.
</div> (Inherited from <a href="T_log4net_Appender_FileAppender_LockingModelBase.htm">FileAppender<span id="LST588ACAFD_23"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_23?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Appender_FileAppender_LockingModelBase_CreateStream.htm">CreateStream</a></td><td><div class="summary">
Helper method that creates a FileStream under CurrentAppender's SecurityContext.
</div> (Inherited from <a href="T_log4net_Appender_FileAppender_LockingModelBase.htm">FileAppender<span id="LST588ACAFD_24"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_24?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/bsc2ak47" target="_blank">Equals</a></td><td><div class="summary">
Determines whether the specified <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is equal to the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/4k87zsw7" target="_blank">Finalize</a></td><td><div class="summary">
Allows an <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> to attempt to free resources and perform other cleanup operations before the <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a> is reclaimed by garbage collection.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/zdee4b3y" target="_blank">GetHashCode</a></td><td><div class="summary">
Serves as a hash function for a particular type.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/dfwy45w9" target="_blank">GetType</a></td><td><div class="summary">
Gets the <a href="http://msdn2.microsoft.com/en-us/library/42892f65" target="_blank">Type</a> of the current instance.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/57ctke0a" target="_blank">MemberwiseClone</a></td><td><div class="summary">
Creates a shallow copy of the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_FileAppender_InterProcessLock_OnClose.htm">OnClose</a></td><td><div class="summary">
Disposes all resources that were initialized by this locking model.
</div> (Overrides <a href="M_log4net_Appender_FileAppender_LockingModelBase_OnClose.htm">FileAppender<span id="LST588ACAFD_25"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_25?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase<span id="LST588ACAFD_26"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_26?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>OnClose<span id="LST588ACAFD_27"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_27?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_FileAppender_InterProcessLock_OpenFile.htm">OpenFile</a></td><td><div class="summary">
Open the file specified and prepare for logging.
</div> (Overrides <a href="M_log4net_Appender_FileAppender_LockingModelBase_OpenFile.htm">FileAppender<span id="LST588ACAFD_28"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_28?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase<span id="LST588ACAFD_29"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_29?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>OpenFile(String, Boolean, Encoding)</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Appender_FileAppender_InterProcessLock_ReleaseLock.htm">ReleaseLock</a></td><td><div class="summary">
Releases the lock and allows others to acquire a lock.
</div> (Overrides <a href="M_log4net_Appender_FileAppender_LockingModelBase_ReleaseLock.htm">FileAppender<span id="LST588ACAFD_30"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_30?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>LockingModelBase<span id="LST588ACAFD_31"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_31?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ReleaseLock<span id="LST588ACAFD_32"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST588ACAFD_32?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">ToString</a></td><td><div class="summary">
Returns a <a href="http://msdn2.microsoft.com/en-us/library/s1wwdcbf" target="_blank">String</a> that represents the current <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.
</div> (Inherited from <a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">Object</a>.)</td></tr></table><a href="#mainBody">Top</a><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="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>