Class LogFilterHelper

Namespace

Microsoft.Practices.EnterpriseLibrary.Logging.Filters

Assembly

Microsoft.Practices.EnterpriseLibrary.Logging.dll

Provides client-side log filtering based on category and priority. Each filter implements the ILogFilter interface and is registered in this class. Category filtering is done using a CategoryFilter and priority filtering is done using a PriorityFilter.

public class LogFilterHelper

Inheritance

object

LogFilterHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LogFilterHelper(IEnumerable<ILogFilter>, ILogFilterErrorHandler)

Initialize a new instance of a LogFilterHelper class. Registers each ILogFilter.

public LogFilterHelper(IEnumerable<ILogFilter> filters, ILogFilterErrorHandler handler)

Parameters

filters IEnumerable<ILogFilter>

The instances of ILogFilter to aggregate.

handler ILogFilterErrorHandler

The handler to deal with errors during filter checking.

Methods

CheckFilters(LogEntry)

Tests the log message against the registered filters.

public bool CheckFilters(LogEntry log)

Parameters

log LogEntry

Log entry message.

Returns

bool

Return true if the message passes through all of the filters.

GetFilter(string)

Gets the filter named name.

public ILogFilter GetFilter(string name)

Parameters

name string

The name of the filter to get.

Returns

ILogFilter

The filter named name, or null if there is no such filter

GetFilter<T>()

Gets the first filter of type T.

public T GetFilter<T>() where T : class, ILogFilter

Returns

T

The first filter of type T, or null if there is no such filter.

Type Parameters

T

The type of the filter to get.

GetFilter<T>(string)

Gets the filter of type T named name.

public T GetFilter<T>(string name) where T : class, ILogFilter

Parameters

name string

The name of the filter to get.

Returns

T

The filter of type T named name, or null if there is no such filter

Type Parameters

T

The type of the filter to get.