blob: 7e016fb685029fc6038f187141dbe50a07208b79 [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>FilterSkeleton Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="FilterSkeleton class" /><meta name="System.Keywords" content="log4net.Filter.FilterSkeleton class" /><meta name="System.Keywords" content="FilterSkeleton class, about FilterSkeleton class" /><meta name="Microsoft.Help.F1" content="log4net.Filter.FilterSkeleton" /><meta name="Microsoft.Help.Id" content="T:log4net.Filter.FilterSkeleton" /><meta name="Description" content="Subclass this type to implement customized logging event filtering" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="'true'" /><meta name="container" content="log4net.Filter" /><meta name="file" content="T_log4net_Filter_FilterSkeleton" /><meta name="guid" content="T_log4net_Filter_FilterSkeleton" /><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">FilterSkeleton 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">
Subclass this type to implement customized logging event filtering
</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><img src="./../icons/online_icon.gif" class="OH_offlineIcon" alt="Online" title="Online" /><a href="http://msdn2.microsoft.com/en-us/library/e5kfa45b" target="_blank">System<span id="ID0EBTNAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBTNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>Object</a><br />  <span class="selflink">log4net.Filter<span id="ID0EBQNAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBQNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>FilterSkeleton</span><br />    <a href="T_log4net_Filter_DenyAllFilter.htm" target="">log4net.Filter<span id="ID0EBNNAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBNNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>DenyAllFilter</a><br />    <a href="T_log4net_Filter_LevelMatchFilter.htm" target="">log4net.Filter<span id="ID0EBKNAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBKNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>LevelMatchFilter</a><br />    <a href="T_log4net_Filter_LevelRangeFilter.htm" target="">log4net.Filter<span id="ID0EBHNAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBHNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>LevelRangeFilter</a><br />    <a href="T_log4net_Filter_LoggerMatchFilter.htm" target="">log4net.Filter<span id="ID0EBENAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBENAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>LoggerMatchFilter</a><br />    <a href="T_log4net_Filter_StringMatchFilter.htm" target="">log4net.Filter<span id="ID0EBBNAAAAA"> </span><script type="text/javascript">
addToLanSpecTextIdSet("ID0EBBNAAAAA?vb=.|cpp=::|cs=.|fs=.|nu=.");
</script>StringMatchFilter</a><br /><p></p><b>Namespace:</b> <a href="N_log4net_Filter.htm" target="">log4net.Filter</a><br /><b>Assembly:</b> <span sdata="assembly">log4net</span> (in log4net.dll) Version: 1.2.14.0 (1.2.14.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 id="snippetGroup_Syntax" class="code"><div id="ID0ECADAAAAA" class="OH_CodeSnippetContainer"><div class="OH_CodeSnippetContainerTabs" id="ID0ECADAAAAA_tabs"><div class="OH_CodeSnippetContainerTabLeftActive" id="ID0ECADAAAAA_tabimgleft"></div><div id="ID0ECADAAAAA_tab1" class="OH_CodeSnippetContainerTabActive" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECADAAAAA','C#','1','4');return false;">C#</a></div><div id="ID0ECADAAAAA_tab2" class="OH_CodeSnippetContainerTab" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECADAAAAA','Visual Basic','2','4');return false;">VB</a></div><div id="ID0ECADAAAAA_tab3" class="OH_CodeSnippetContainerTab" EnableCopyCode="true"><a href="#" onclick="javascript:ChangeTab('ID0ECADAAAAA','Visual C++','3','4');return false;">C++</a></div><div id="ID0ECADAAAAA_tab4" class="OH_CodeSnippetContainerTabDisabledNotFirst" EnableCopyCode="true" disabled="true"><a>F#</a></div><div class="OH_CodeSnippetContainerTabRight" id="ID0ECADAAAAA_tabimgright"></div></div><div id="ID0ECADAAAAA_codecollection" class="OH_CodeSnippetContainerCodeCollection"><div class="OH_CodeSnippetToolBar"><div class="OH_CodeSnippetToolBarText"><a id="ID0ECADAAAAA_ViewColorized" href="#" onclick="javascript:ExchangeTitleContent('ID0ECADAAAAA','4')" title="View Colorized" style="display: none">View Colorized</a><a id="ID0ECADAAAAA_copycode" href="#" onclick="javascript:CopyToClipboard('ID0ECADAAAAA','4')" title="Copy to Clipboard">Copy to Clipboard</a><a id="ID0ECADAAAAA_PrintText" class="OH_PrintText" href="#" onclick="javascript:Print('ID0ECADAAAAA','4')" title="Print">Print</a></div></div><div id="ID0ECADAAAAA_code_Div1" class="OH_CodeSnippetContainerCode" style="display: block"><pre><span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class</span> <span class="identifier">FilterSkeleton</span> : <span class="identifier">IFilter</span>,
<span class="identifier">IOptionHandler</span></pre></div><div id="ID0ECADAAAAA_code_Plain_Div1" class="OH_CodeSnippetContainerCode" style="display: none"><pre>public abstract class FilterSkeleton : IFilter,
IOptionHandler</pre></div><div id="ID0ECADAAAAA_code_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre><span class="keyword">Public</span> <span class="keyword">MustInherit</span> <span class="keyword">Class</span> <span class="identifier">FilterSkeleton</span> 
<span class="keyword">Implements</span> <span class="identifier">IFilter</span>, <span class="identifier">IOptionHandler</span></pre></div><div id="ID0ECADAAAAA_code_Plain_Div2" class="OH_CodeSnippetContainerCode" style="display: none"><pre>Public MustInherit Class FilterSkeleton 
Implements IFilter, IOptionHandler</pre></div><div id="ID0ECADAAAAA_code_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">FilterSkeleton</span> <span class="keyword">abstract</span> : <span class="identifier">IFilter</span>,
<span class="identifier">IOptionHandler</span></pre></div><div id="ID0ECADAAAAA_code_Plain_Div3" class="OH_CodeSnippetContainerCode" style="display: none"><pre>public ref class FilterSkeleton abstract : IFilter,
IOptionHandler</pre></div><div id="ID0ECADAAAAA_code_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div><div id="ID0ECADAAAAA_code_Plain_Div4" class="OH_CodeSnippetContainerCode" style="display: none"><pre /></div></div></div><script>addSpecificTextLanguageTagSet('ID0ECADAAAAA');</script></div><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>
Users should extend this class to implement customized logging
event filtering. Note that <a href="T_log4net_Repository_Hierarchy_Logger.htm" target="">Logger</a> and
<a href="T_log4net_Appender_AppenderSkeleton.htm" target="">AppenderSkeleton</a>, the parent class of all standard
appenders, have built-in filtering rules. It is suggested that you
first use and understand the built-in rules before rushing to write
your own custom filters.
</p><p>
This abstract class assumes and also imposes that filters be
organized in a linear chain. The <a href="M_log4net_Filter_FilterSkeleton_Decide.htm" target="">Decide(LoggingEvent)</a>
method of each filter is called sequentially, in the order of their
addition to the chain.
</p><p>
The <a href="M_log4net_Filter_FilterSkeleton_Decide.htm" target="">Decide(LoggingEvent)</a> method must return one
of the integer constants <a href="T_log4net_Filter_FilterDecision.htm" target="">Deny</a>,
<a href="T_log4net_Filter_FilterDecision.htm" target="">Neutral</a> or <a href="T_log4net_Filter_FilterDecision.htm" target="">Accept</a>.
</p><p>
If the value <a href="T_log4net_Filter_FilterDecision.htm" target="">Deny</a> is returned, then the log event is dropped
immediately without consulting with the remaining filters.
</p><p>
If the value <a href="T_log4net_Filter_FilterDecision.htm" target="">Neutral</a> is returned, then the next filter
in the chain is consulted. If there are no more filters in the
chain, then the log event is logged. Thus, in the presence of no
filters, the default behavior is to log all logging events.
</p><p>
If the value <a href="T_log4net_Filter_FilterDecision.htm" target="">Accept</a> is returned, then the log
event is logged without consulting the remaining filters.
</p><p>
The philosophy of log4net filters is largely inspired from the
Linux ipchains.
</p><a name="seeAlsoSection"><!----></a><div class="OH_CollapsibleAreaRegion"><div class="OH_regiontitle">See Also</div><div class="OH_CollapsibleArea_HrDiv"><hr class="OH_CollapsibleArea_Hr" /></div></div><div class="OH_clear"></div><div class="seeAlsoStyle"><a href="AllMembers_T_log4net_Filter_FilterSkeleton.htm" target="">FilterSkeleton Members</a></div><div class="seeAlsoStyle"><a href="N_log4net_Filter.htm" target="">log4net.Filter Namespace</a></div></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+FilterSkeleton+Class+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>