blob: d5126b2394e54673908c61faa9835567c8b9a022 [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>Logger Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="Logger class" /><meta name="System.Keywords" content="log4net.Repository.Hierarchy.Logger class" /><meta name="System.Keywords" content="Logger class, about Logger class" /><meta name="Microsoft.Help.F1" content="log4net.Repository.Hierarchy.Logger" /><meta name="Microsoft.Help.Id" content="T:log4net.Repository.Hierarchy.Logger" /><meta name="Description" content="Implementation of used by" /><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_Logger" /><meta name="guid" content="T_log4net_Repository_Hierarchy_Logger" /></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">Logger 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">
Implementation of <a href="T_log4net_Core_ILogger.htm">ILogger</a> used by <a href="P_log4net_Repository_Hierarchy_Logger_Hierarchy.htm">Hierarchy</a></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="LST2BD9FBD6_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST2BD9FBD6_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Object</a><br />  <span class="selflink">log4net.Repository.Hierarchy<span id="LST2BD9FBD6_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST2BD9FBD6_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>Logger</span><br />    <a href="T_log4net_Repository_Hierarchy_RootLogger.htm">log4net.Repository.Hierarchy<span id="LST2BD9FBD6_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST2BD9FBD6_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>RootLogger</a><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.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">abstract</span> <span class="keyword">class</span> <span class="identifier">Logger</span> : <span class="identifier">IAppenderAttachable</span>,
<span class="identifier">ILogger</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">MustInherit</span> <span class="keyword">Class</span> <span class="identifier">Logger</span>
<span class="keyword">Implements</span> <span class="identifier">IAppenderAttachable</span>, <span class="identifier">ILogger</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">Logger</span> <span class="keyword">abstract</span> : <span class="identifier">IAppenderAttachable</span>,
<span class="identifier">ILogger</span></pre></div><div id="ID0EDCA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre xml:space="preserve">[&lt;<span class="identifier">AbstractClassAttribute</span>&gt;]
<span class="keyword">type</span> <span class="identifier">Logger</span> =
<span class="keyword">class</span>
<span class="keyword">interface</span> <span class="identifier">IAppenderAttachable</span>
<span class="keyword">interface</span> <span class="identifier">ILogger</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID0EDCA");</script><p>The <span class="selflink">Logger</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="protected;declared;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="M_log4net_Repository_Hierarchy_Logger__ctor.htm">Logger</a></td><td><div class="summary">
This constructor created a new <span class="selflink">Logger</span> instance and
sets its name.
</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;declared;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></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_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></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_Logger_EffectiveLevel.htm">EffectiveLevel</a></td><td><div class="summary">
Gets the effective level for this logger.
</div></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_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></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_Logger_Level.htm">Level</a></td><td><div class="summary">
Gets or sets the assigned <a href="P_log4net_Repository_Hierarchy_Logger_Level.htm">Level</a>, if any, for this Logger.
</div></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_Logger_Name.htm">Name</a></td><td><div class="summary">
Gets the logger name.
</div></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_Logger_Parent.htm">Parent</a></td><td><div class="summary">
Gets or sets the parent logger in the hierarchy.
</div></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_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></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_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></td></tr><tr data="protected;declared;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></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_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></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;declared;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></td></tr><tr data="protected;declared;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></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_Repository_Hierarchy_Logger_GetAppender.htm">GetAppender</a></td><td><div class="summary">
Look for the appender named as <span class="code">name</span></div></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;declared;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></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_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></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_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></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_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></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_Repository_Hierarchy_Logger_RemoveAllAppenders.htm">RemoveAllAppenders</a></td><td><div class="summary">
Remove all previously added appenders from this Logger instance.
</div></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_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></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_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></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>
Internal class used to provide implementation of <a href="T_log4net_Core_ILogger.htm">ILogger</a>
interface. Applications should use <a href="T_log4net_LogManager.htm">LogManager</a> to get
logger instances.
</p><p>
This is one of the central classes in the log4net implementation. One of the
distinctive features of log4net are hierarchical loggers and their
evaluation. The <a href="P_log4net_Repository_Hierarchy_Logger_Hierarchy.htm">Hierarchy</a> organizes the <span class="selflink">Logger</span>
instances into a rooted tree hierarchy.
</p><p>
The <span class="selflink">Logger</span> class is abstract. Only concrete subclasses of
<span class="selflink">Logger</span> can be created. The <a href="T_log4net_Repository_Hierarchy_ILoggerFactory.htm">ILoggerFactory</a>
is used to create instances of this type for the <a href="P_log4net_Repository_Hierarchy_Logger_Hierarchy.htm">Hierarchy</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="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>