blob: 32caba26664909f43b3c9c06151aeafb5440b9d6 [file] [log] [blame]
<html xmlns:MSHelp="http://msdn.microsoft.com/mshelp" xmlns:mshelp="http://msdn.microsoft.com/mshelp"><head><link rel="SHORTCUT ICON" href="./../icons/favicon.ico" /><style type="text/css">.OH_CodeSnippetContainerTabLeftActive, .OH_CodeSnippetContainerTabLeft,.OH_CodeSnippetContainerTabLeftDisabled { backgroundImageName: tabLeftBG.gif; }.OH_CodeSnippetContainerTabRightActive, .OH_CodeSnippetContainerTabRight,.OH_CodeSnippetContainerTabRightDisabled { backgroundImageName: tabRightBG.gif; }.OH_footer { backgroundImageName: footer_slice.gif; background-position: top; background-repeat: repeat-x; }</style><link rel="stylesheet" type="text/css" href="./../styles/branding.css" /><link rel="stylesheet" type="text/css" href="./../styles/branding-en-US.css" /><style type="text/css">
body
{
border-left:5px solid #e6e6e6;
overflow-x:scroll;
overflow-y:scroll;
}
</style><script src="./../scripts/branding.js" type="text/javascript"><!----></script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>log4net.Util Namespace</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="log4net.Util namespace" /><meta name="Microsoft.Help.F1" content="log4net.Util" /><meta name="Microsoft.Help.Id" content="N:log4net.Util" /><meta name="Description" content=" " /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="'true'" /><meta name="container" content="log4net.Util" /><meta name="file" content="N_log4net_Util" /><meta name="guid" content="N_log4net_Util" /><link type="text/css" rel="stylesheet" href="ms-help://Hx/HxRuntime/HxLink.css" /><meta name="SelfBranded" content="true" /></head><body onload="onLoad()" class="primary-mtps-offline-document"><div class="OH_outerDiv"><div class="OH_outerContent"><table class="TitleTable"><tr><td class="OH_tdTitleColumn">log4net.Util Namespace</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"> </div><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Classes</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><table id="typeList" class="members"><tr><th class="ps_iconColumn">
 
</th><th class="ps_nameColumn">Class</th><th class="ps_descriptionColumn">Description</th></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_AppenderAttachedImpl.htm" target="">AppenderAttachedImpl</a></td><td><div class="summary">
A straightforward implementation of the <a href="T_log4net_Core_IAppenderAttachable.htm" target="">IAppenderAttachable</a> interface.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_CompositeProperties.htm" target="">CompositeProperties</a></td><td><div class="summary">
This class aggregates several PropertiesDictionary collections together.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ContextPropertiesBase.htm" target="">ContextPropertiesBase</a></td><td><div class="summary">
Base class for Context Properties implementations
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ConverterInfo.htm" target="">ConverterInfo</a></td><td><div class="summary">
Wrapper class used to map converter names to converter types
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_CountingQuietTextWriter.htm" target="">CountingQuietTextWriter</a></td><td><div class="summary">
Subclass of <a href="T_log4net_Util_QuietTextWriter.htm" target="">QuietTextWriter</a> that maintains a count of
the number of bytes written.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_CyclicBuffer.htm" target="">CyclicBuffer</a></td><td><div class="summary">
A fixed size rolling buffer of logging events.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_EmptyCollection.htm" target="">EmptyCollection</a></td><td><div class="summary">
An always empty <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/b1ht6113" target="_blank">ICollection</a>.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_EmptyDictionary.htm" target="">EmptyDictionary</a></td><td><div class="summary">
An always empty <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/9dhwsays" target="_blank">IDictionary</a>.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_FormattingInfo.htm" target="">FormattingInfo</a></td><td><div class="summary">
Contain the information obtained when parsing formatting modifiers
in conversion modifiers.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_GlobalContextProperties.htm" target="">GlobalContextProperties</a></td><td><div class="summary">
Implementation of Properties collection for the <a href="T_log4net_GlobalContext.htm" target="">GlobalContext</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ILogExtensions.htm" target="">ILogExtensions</a></td><td><div class="summary">
The static class ILogExtensions contains a set of widely used
methods that ease the interaction with the ILog interface implementations.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_LevelMapping.htm" target="">LevelMapping</a></td><td><div class="summary">
Manages a mapping from levels to <a href="T_log4net_Util_LevelMappingEntry.htm" target="">LevelMappingEntry</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_LevelMappingEntry.htm" target="">LevelMappingEntry</a></td><td><div class="summary">
An entry in the <a href="T_log4net_Util_LevelMapping.htm" target="">LevelMapping</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_LogicalThreadContextProperties.htm" target="">LogicalThreadContextProperties</a></td><td><div class="summary">
Implementation of Properties collection for the <a href="T_log4net_LogicalThreadContext.htm" target="">LogicalThreadContext</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_LogicalThreadContextStack.htm" target="">LogicalThreadContextStack</a></td><td><div class="summary">
Implementation of Stack for the <a href="T_log4net_LogicalThreadContext.htm" target="">LogicalThreadContext</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_LogicalThreadContextStacks.htm" target="">LogicalThreadContextStacks</a></td><td><div class="summary">
Implementation of Stacks collection for the <a href="T_log4net_LogicalThreadContext.htm" target="">LogicalThreadContext</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_LogLog.htm" target="">LogLog</a></td><td><div class="summary">
Outputs log statements from within the log4net assembly.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_LogLog_LogReceivedAdapter.htm" target="">LogLog<span id="ID0EBABZACAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBABZACAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>LogReceivedAdapter</a></td><td><div class="summary">
Subscribes to the LogLog.LogReceived event and stores messages
to the supplied IList instance.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_LogReceivedEventArgs.htm" target="">LogReceivedEventArgs</a></td><td><div class="summary"></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_NativeError.htm" target="">NativeError</a></td><td><div class="summary">
Represents a native error code and message.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_NullDictionaryEnumerator.htm" target="">NullDictionaryEnumerator</a></td><td><div class="summary">
An always empty <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/ebe1zk2c" target="_blank">IDictionaryEnumerator</a>.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_NullEnumerator.htm" target="">NullEnumerator</a></td><td><div class="summary">
An always empty <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/1t2267t6" target="_blank">IEnumerator</a>.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_NullSecurityContext.htm" target="">NullSecurityContext</a></td><td><div class="summary">
A SecurityContext used when a SecurityContext is not required
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_OnlyOnceErrorHandler.htm" target="">OnlyOnceErrorHandler</a></td><td><div class="summary">
Implements log4net's default error handling policy which consists
of emitting a message for the first error in an appender and
ignoring all subsequent errors.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_OptionConverter.htm" target="">OptionConverter</a></td><td><div class="summary">
A convenience class to convert property values to specific types.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_PatternConverter.htm" target="">PatternConverter</a></td><td><div class="summary">
Abstract class that provides the formatting functionality that
derived classes need.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_PatternParser.htm" target="">PatternParser</a></td><td><div class="summary">
Most of the work of the <a href="T_log4net_Layout_PatternLayout.htm" target="">PatternLayout</a> class
is delegated to the PatternParser class.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_PatternString.htm" target="">PatternString</a></td><td><div class="summary">
This class implements a patterned string.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_PropertiesDictionary.htm" target="">PropertiesDictionary</a></td><td><div class="summary">
String keyed object map.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_PropertyEntry.htm" target="">PropertyEntry</a></td><td><div class="summary">
A class to hold the key and data for a property set in the config file
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ProtectCloseTextWriter.htm" target="">ProtectCloseTextWriter</a></td><td><div class="summary">
A <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/ywxh2328" target="_blank">TextWriter</a> that ignores the <a href="M_log4net_Util_ProtectCloseTextWriter_Close.htm" target="">Close<span id="ID0EABAAMACAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EABAAMACAAAAA?vb=|cpp=()|cs=()|fs=()|nu=()");
</script></a> message
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_QuietTextWriter.htm" target="">QuietTextWriter</a></td><td><div class="summary"><img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/ywxh2328" target="_blank">TextWriter</a> that does not leak exceptions
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ReaderWriterLock.htm" target="">ReaderWriterLock</a></td><td><div class="summary">
Defines a lock that supports single writers and multiple readers
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ReadOnlyPropertiesDictionary.htm" target="">ReadOnlyPropertiesDictionary</a></td><td><div class="summary">
String keyed object map that is read only.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ReusableStringWriter.htm" target="">ReusableStringWriter</a></td><td><div class="summary">
A <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/hs9kt2e9" target="_blank">StringWriter</a> that can be <a href="M_log4net_Util_ReusableStringWriter_Reset.htm" target="">Reset(Int32, Int32)</a> and reused
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_SystemInfo.htm" target="">SystemInfo</a></td><td><div class="summary">
Utility class for system specific information.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_SystemStringFormat.htm" target="">SystemStringFormat</a></td><td><div class="summary">
Utility class that represents a format string.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_TextWriterAdapter.htm" target="">TextWriterAdapter</a></td><td><div class="summary">
Adapter that extends <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/ywxh2328" target="_blank">TextWriter</a> and forwards all
messages to an instance of <img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/ywxh2328" target="_blank">TextWriter</a>.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ThreadContextProperties.htm" target="">ThreadContextProperties</a></td><td><div class="summary">
Implementation of Properties collection for the <a href="T_log4net_ThreadContext.htm" target="">ThreadContext</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ThreadContextStack.htm" target="">ThreadContextStack</a></td><td><div class="summary">
Implementation of Stack for the <a href="T_log4net_ThreadContext.htm" target="">ThreadContext</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_ThreadContextStacks.htm" target="">ThreadContextStacks</a></td><td><div class="summary">
Implementation of Stacks collection for the <a href="T_log4net_ThreadContext.htm" target="">ThreadContext</a></div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_Transform.htm" target="">Transform</a></td><td><div class="summary">
Utility class for transforming strings.
</div></td></tr><tr data="class; public"><td><img src="./../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_log4net_Util_WindowsSecurityContext.htm" target="">WindowsSecurityContext</a></td><td><div class="summary">
Impersonate a Windows Account
</div></td></tr></table><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Delegates</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><table id="typeList" class="members"><tr><th class="ps_iconColumn">
 
</th><th class="ps_nameColumn">Delegate</th><th class="ps_descriptionColumn">Description</th></tr><tr data="delegate; public"><td><img src="./../icons/pubdelegate.gif" alt="Public delegate" title="Public delegate" /></td><td><a href="T_log4net_Util_LogReceivedEventHandler.htm" target="">LogReceivedEventHandler</a></td><td><div class="summary"></div></td></tr><tr data="delegate; public"><td><img src="./../icons/pubdelegate.gif" alt="Public delegate" title="Public delegate" /></td><td><a href="T_log4net_Util_TwoArgAction_2.htm" target="">TwoArgAction<span id="ID0ECABAABAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0ECABAABAAAAA?vb=(Of |cpp=&lt;|cs=&lt;|fs=&lt;'|nu=(");
</script>T1, T2<span id="ID0EAABAABAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EAABAABAAAAA?vb=)|cpp=&gt;|cs=&gt;|fs=&gt;|nu=)");
</script></a></td><td><div class="summary">
Delegate type used for LogicalThreadContextStack's callbacks.
</div></td></tr></table><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">Enumerations</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><table id="typeList" class="members"><tr><th class="ps_iconColumn">
 
</th><th class="ps_nameColumn">Enumeration</th><th class="ps_descriptionColumn">Description</th></tr><tr data="enumeration; public"><td><img src="./../icons/pubenumeration.gif" alt="Public enumeration" title="Public enumeration" /></td><td><a href="T_log4net_Util_WindowsSecurityContext_ImpersonationMode.htm" target="">WindowsSecurityContext<span id="ID0EBABAAAAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBABAAAAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>ImpersonationMode</a></td><td><div class="summary">
The impersonation modes for the <a href="T_log4net_Util_WindowsSecurityContext.htm" target="">WindowsSecurityContext</a></div></td></tr></table></div></div></div></div><div id="OH_footer" class="OH_footer"><p>Apache log4net, Apache and log4net are trademarks of The Apache Software Foundation.</p><p><a href="http://logging.apache.org/log4net/" target="_blank"><img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /> 
Copyright 2004-2015 The Apache Software Foundation (http://logging.apache.org/log4net/)</a></p><div class="OH_feedbacklink"><a href="mailto:http://logging.apache.org/log4net/mail-lists.html?subject=Apache+log4net%e2%84%a2+SDK+Documentation+log4net.Util+Namespace+100+EN-US&amp;body=Your%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.%20While%20working%20to%20resolve%20the%20issue%20that%20you%20report%2c%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%2c%20you%20may%20receive%20an%20e-mail%20to%20let%20you%20know%20that%20your%20feedback%20has%20been%20addressed.">Send Feedback</a> on this topic to http://logging.apache.org/log4net/mail-lists.html.</div></div></body></html>