LoggingOptions.SetColumnFilter(String, DTSEventColumnFilter) Method

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Sets column filter for the specified event.

public:
 void SetColumnFilter(System::String ^ eventName, Microsoft::SqlServer::Dts::Runtime::DTSEventColumnFilter columnFilter);

public void SetColumnFilter (string eventName, Microsoft.SqlServer.Dts.Runtime.DTSEventColumnFilter columnFilter);

member this.SetColumnFilter : string * Microsoft.SqlServer.Dts.Runtime.DTSEventColumnFilter -> unit

Public Sub SetColumnFilter (eventName As String, columnFilter As DTSEventColumnFilter)

Parameters

eventName

String

The name of the event whose columns you want to control.

columnFilter

DTSEventColumnFilter

A DTSEventColumnFilter with values set to true or false, depending on if you want the column included (true) or excluded (false).

Examples

The following code example creates a Package and selects a log provider for it. The code example then sets the fields of the DTSEventColumnFilter to true to include that field in the log, or false to exclude the field from the log. The SetColumnFilter then defines that the fields with a value of true are logged when the package incurs an OnError event.

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

namespace HttpClientConn  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            Package pkg = new Package();  
            LogProvider log1 = pkg.LogProviders.Add("DTS.LogProviderTextFile.1");  
            pkg.LoggingOptions.SelectedLogProviders.Add(log1);  
            LoggingOptions lOpts = pkg.LoggingOptions;  

            DTSEventColumnFilter ecf = new DTSEventColumnFilter();  
            // Set the detailed information to log when the event occurs.  
            // This specifies to log the Computer, Operator, and SourceName only.  
            ecf.Computer = true;  
            ecf.Operator = true;  
            ecf.SourceName = true;  
            ecf.SourceID = false;  
            ecf.ExecutionID = false;  
            ecf.MessageText = false;  
            ecf.DataBytes = false;  
            // The event is the first parameter, and the columns to log is the enumeration.   
            lOpts.SetColumnFilter("OnError", ecf);  
        }  
    }  
}  

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

Namespace HttpClientConn  
    Class Program  
        Shared  Sub Main(ByVal args() As String)  
            Dim pkg As Package =  New Package()   
            Dim log1 As LogProvider =  pkg.LogProviders.Add("DTS.LogProviderTextFile.1")   
            pkg.LoggingOptions.SelectedLogProviders.Add(log1)  
            Dim lOpts As LoggingOptions =  pkg.LoggingOptions   

            Dim ecf As DTSEventColumnFilter =  New DTSEventColumnFilter()   
            ' Set the detailed information to log when the event occurs.  
            ' This specifies to log the Computer, Operator, and SourceName only.  
            ecf.Computer = True  
            ecf.Operator = True  
            ecf.SourceName = True  
            ecf.SourceID = False  
            ecf.ExecutionID = False  
            ecf.MessageText = False  
            ecf.DataBytes = False  
            ' The event is the first parameter, and the columns to log is the enumeration.   
            lOpts.SetColumnFilter("OnError", ecf)  
        End Sub  
    End Class  
End Namespace