LoggingOptions.EventFilterKind Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets or sets a value that describes the kind of event filter that is set, whether included or excluded.

public:
 property Microsoft::SqlServer::Dts::Runtime::DTSEventFilterKind EventFilterKind { Microsoft::SqlServer::Dts::Runtime::DTSEventFilterKind get(); void set(Microsoft::SqlServer::Dts::Runtime::DTSEventFilterKind value); };

public Microsoft.SqlServer.Dts.Runtime.DTSEventFilterKind EventFilterKind { get; set; }

member this.EventFilterKind : Microsoft.SqlServer.Dts.Runtime.DTSEventFilterKind with get, set

Public Property EventFilterKind As DTSEventFilterKind

Property Value

DTSEventFilterKind

A value from the DTSEventFilterKind enumeration that indicates whether the events added to the EventFilter are included or excluded from the Event Log.

Examples

The following code example enables logging on a package, adds a log provider, then displays the default value of the EventFilterKind. Using the DTSEventFilterKind enumeration, the default value is changed.

using System;  
using System.Collections.Generic;  
using System.Text;  
using Microsoft.SqlServer.Dts.Runtime;  

namespace Microsoft.SqlServer.SSIS.Sample  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            Package pkg = new Package();  
            pkg.LoggingMode = DTSLoggingMode.Enabled;  
            LogProvider log1 = pkg.LogProviders.Add("DTS.LogProviderTextFile.1");  
            pkg.LoggingOptions.SelectedLogProviders.Add(log1);  
            LoggingOptions lOpts = pkg.LoggingOptions;  
            Console.WriteLine("EventFilterKind: {0}", pkg.LoggingOptions.EventFilterKind.ToString());  

            pkg.LoggingOptions.EventFilterKind = DTSEventFilterKind.Inclusion;  
            Console.WriteLine("EventFilterKind: {0}", pkg.LoggingOptions.EventFilterKind.ToString());  
        }  
    }  
}  

Imports System  
Imports System.Collections.Generic  
Imports System.Text  
Imports Microsoft.SqlServer.Dts.Runtime  

Namespace Microsoft.SqlServer.SSIS.Sample  
    Class Program  
        Shared  Sub Main(ByVal args() As String)  
            Dim pkg As Package =  New Package()   
            pkg.LoggingMode = DTSLoggingMode.Enabled  
            Dim log1 As LogProvider =  pkg.LogProviders.Add("DTS.LogProviderTextFile.1")   
            pkg.LoggingOptions.SelectedLogProviders.Add(log1)  
            Dim lOpts As LoggingOptions =  pkg.LoggingOptions   
            Console.WriteLine("EventFilterKind: {0}", pkg.LoggingOptions.EventFilterKind.ToString())  

            pkg.LoggingOptions.EventFilterKind = DTSEventFilterKind.Inclusion  
            Console.WriteLine("EventFilterKind: {0}", pkg.LoggingOptions.EventFilterKind.ToString())  
        End Sub  
    End Class  
End Namespace  

Sample Output:

EventFilterKind: Exclusion

EventFilterKind: Inclusion

Remarks

For more information, see Enabling Logging Programmatically.