blob: b8933489360d0ce8ef013ffe78c3bae0672928f1 [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>RootLogger Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="RootLogger class" /><meta name="System.Keywords" content="log4net.Repository.Hierarchy.RootLogger class" /><meta name="System.Keywords" content="RootLogger class, about RootLogger class" /><meta name="Microsoft.Help.F1" content="log4net.Repository.Hierarchy.RootLogger" /><meta name="Microsoft.Help.Id" content="T:log4net.Repository.Hierarchy.RootLogger" /><meta name="Description" content="The sits at the root of the logger hierarchy tree." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="log4net.Repository.Hierarchy" /><meta name="file" content="T_log4net_Repository_Hierarchy_RootLogger" /><meta name="guid" content="T_log4net_Repository_Hierarchy_RootLogger" /></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">RootLogger 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">
The <span class="selflink">RootLogger</span> sits at the root of the logger hierarchy tree.
</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="LSTEA10ECD2_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEA10ECD2_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <a href="T_log4net_Repository_Hierarchy_Logger.htm">log4net.Repository.Hierarchy<span id="LSTEA10ECD2_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEA10ECD2_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Logger</a><br />    <span class="selflink">log4net.Repository.Hierarchy<span id="LSTEA10ECD2_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEA10ECD2_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>RootLogger</span><br /><p> </p><strong>Namespace:</strong> <a href="N_log4net_Repository_Hierarchy.htm">log4net.Repository.Hierarchy</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="keyword">class</span> <span class="identifier">RootLogger</span> : <span class="identifier">Logger</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">RootLogger</span>
<span class="keyword">Inherits</span> <span class="identifier">Logger</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">RootLogger</span> : <span class="keyword">public</span> <span class="identifier">Logger</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">RootLogger</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">Logger</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><p>The <span class="selflink">RootLogger</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_Repository_Hierarchy_RootLogger__ctor.htm">RootLogger</a></td><td><div class="summary">
Construct a <span class="selflink">RootLogger</span></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_Repository_Hierarchy_Logger_Additivity.htm">Additivity</a></td><td><div class="summary">
Gets or sets a value indicating if child loggers inherit their parent's appenders.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Repository_Hierarchy_Logger_Appenders.htm">Appenders</a></td><td><div class="summary">
Get the appenders contained in this logger as an
<a href="http://msdn2.microsoft.com/en-us/library/b1ht6113" target="_blank">ICollection</a>.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Repository_Hierarchy_RootLogger_EffectiveLevel.htm">EffectiveLevel</a></td><td><div class="summary">
Gets the assigned level value without walking the logger hierarchy.
</div> (Overrides <a href="P_log4net_Repository_Hierarchy_Logger_EffectiveLevel.htm">Logger<span id="LSTEA10ECD2_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEA10ECD2_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>EffectiveLevel</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Repository_Hierarchy_Logger_Hierarchy.htm">Hierarchy</a></td><td><div class="summary">
Gets or sets the <a href="P_log4net_Repository_Hierarchy_Logger_Hierarchy.htm">Hierarchy</a> where this
<span class="code">Logger</span> instance is attached to.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Repository_Hierarchy_RootLogger_Level.htm">Level</a></td><td><div class="summary">
Gets or sets the assigned <a href="P_log4net_Repository_Hierarchy_RootLogger_Level.htm">Level</a> for the root logger.
</div> (Overrides <a href="P_log4net_Repository_Hierarchy_Logger_Level.htm">Logger<span id="LSTEA10ECD2_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTEA10ECD2_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Level</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Repository_Hierarchy_Logger_Name.htm">Name</a></td><td><div class="summary">
Gets the logger name.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Repository_Hierarchy_Logger_Parent.htm">Parent</a></td><td><div class="summary">
Gets or sets the parent logger in the hierarchy.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="P_log4net_Repository_Hierarchy_Logger_Repository.htm">Repository</a></td><td><div class="summary">
Gets the <a href="T_log4net_Repository_ILoggerRepository.htm">ILoggerRepository</a> where this
<span class="code">Logger</span> instance is attached to.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</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;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_AddAppender.htm">AddAppender</a></td><td><div class="summary">
Add <span class="parameter">newAppender</span> to the list of appenders of this
Logger instance.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</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_Repository_Hierarchy_Logger_CallAppenders.htm">CallAppenders</a></td><td><div class="summary">
Deliver the <a href="T_log4net_Core_LoggingEvent.htm">LoggingEvent</a> to the attached appenders.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_CloseNestedAppenders.htm">CloseNestedAppenders</a></td><td><div class="summary">
Closes all attached appenders implementing the <a href="T_log4net_Core_IAppenderAttachable.htm">IAppenderAttachable</a> interface.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</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="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_ForcedLog.htm">ForcedLog(LoggingEvent)</a></td><td><div class="summary">
Creates a new logging event and logs the event without further checks.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</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_Repository_Hierarchy_Logger_ForcedLog_1.htm">ForcedLog(Type, Level, Object, Exception)</a></td><td><div class="summary">
Creates a new logging event and logs the event without further checks.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_GetAppender.htm">GetAppender</a></td><td><div class="summary">
Look for the appender named as <span class="code">name</span></div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</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="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_IsEnabledFor.htm">IsEnabledFor</a></td><td><div class="summary">
Checks if this logger is enabled for a given <a href="P_log4net_Repository_Hierarchy_Logger_Level.htm">Level</a> passed as parameter.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_Log_1.htm">Log(LoggingEvent)</a></td><td><div class="summary">
This is the most generic printing method that is intended to be used
by wrappers.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_Log.htm">Log(Level, Object, Exception)</a></td><td><div class="summary">
This is the most generic printing method. This generic form is intended to be used by wrappers
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_Log_2.htm">Log(Type, Level, Object, Exception)</a></td><td><div class="summary">
This generic form is intended to be used by wrappers.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</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;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_RemoveAllAppenders.htm">RemoveAllAppenders</a></td><td><div class="summary">
Remove all previously added appenders from this Logger instance.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_RemoveAppender_1.htm">RemoveAppender(String)</a></td><td><div class="summary">
Remove the appender passed as parameter form the list of appenders.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a>.)</td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger_RemoveAppender.htm">RemoveAppender(IAppender)</a></td><td><div class="summary">
Remove the appender passed as parameter form the list of appenders.
</div> (Inherited from <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</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"><div class="OH_regiontitle">Remarks</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"> </div><p>
The <span class="selflink">RootLogger</span> is a regular <a href="T_log4net_Repository_Hierarchy_Logger.htm">Logger</a> except
that it provides several guarantees.
</p><p>
First, it cannot be assigned a <span class="code">null</span>
level. Second, since the root logger cannot have a parent, the
<a href="P_log4net_Repository_Hierarchy_RootLogger_EffectiveLevel.htm">EffectiveLevel</a> property always returns the value of the
level field without walking the hierarchy.
</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="N_log4net_Repository_Hierarchy.htm">log4net.Repository.Hierarchy 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>