LogProvider.ConfigString Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets or sets the connection and configuration information for the specific log provider.

public:
 property System::String ^ ConfigString { System::String ^ get(); void set(System::String ^ value); };

public string ConfigString { get; set; }

member this.ConfigString : string with get, set

Public Property ConfigString As String

Property Value

String

A String that contains the configuration state to either save or load.

Examples

The following code example loads a package for which logging has been enabled. After loading the package, the LogProviders collection is created, and each log provider in the collection is enumerated over, printing the values for each property, including the ConfigString.

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

namespace LogProvider_Properties_Test  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            // The package is one of the SSIS samples,  
            // modified to log information to the "SSIS  
            // log provider for Text files".  
            string mySample = @"C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx";  
            // Create the Application, and load the sample.  
            Application app = new Application();  
            Package pkg = app.LoadPackage(mySample, null);  

            // Get the LogProviders collection from the package.  
            LogProviders logProvs = pkg.LogProviders;  
            foreach (LogProvider logProv in logProvs)  
            {  
                Console.WriteLine("ConfigString:   {0}", logProv.ConfigString);  
                Console.WriteLine("CreationName    {0}", logProv.CreationName);  
                Console.WriteLine("DelayValidation {0}", logProv.DelayValidation);  
                Console.WriteLine("Description     {0}", logProv.Description);  
                Console.WriteLine("HostType        {0}", logProv.HostType);  
                Console.WriteLine("ID              {0}", logProv.ID);  
                Console.WriteLine("InnerObject     {0}", logProv.InnerObject);  
                Console.WriteLine("Name            {0}", logProv.Name);  
             }  
        }  
    }  
}  

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

Namespace LogProvider_Properties_Test  
    Class Program  
        Shared  Sub Main(ByVal args() As String)  
            ' The package is one of the SSIS samples,  
            ' modified to log information to the "SSIS  
            ' log provider for Text files".  
            Dim mySample As String =  "C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx"   
            ' Create the Application, and load the sample.  
            Dim app As Application =  New Application()   
            Dim pkg As Package =  app.LoadPackage(mySample,Nothing)   

            ' Get the LogProviders collection from the package.  
            Dim logProvs As LogProviders =  pkg.LogProviders   
            Dim logProv As LogProvider  
            For Each logProv In logProvs  
                Console.WriteLine("ConfigString:   {0}", logProv.ConfigString)  
                Console.WriteLine("CreationName    {0}", logProv.CreationName)  
                Console.WriteLine("DelayValidation {0}", logProv.DelayValidation)  
                Console.WriteLine("Description     {0}", logProv.Description)  
                Console.WriteLine("HostType        {0}", logProv.HostType)  
                Console.WriteLine("ID              {0}", logProv.ID)  
                Console.WriteLine("InnerObject     {0}", logProv.InnerObject)  
                Console.WriteLine("Name            {0}", logProv.Name)  
            Next  
        End Sub  
    End Class  
End Namespace  

Sample Output:

ConfigString:

CreationName DTS.LogProviderTextFile.1

DelayValidation False

Description Writes log entries for events to a CSV file

HostType LogProvider

ID {1E107E39-DB79-4F02-B8A7-61D88F2DEF63}

InnerObject System.__ComObject

Name SSIS log provider for Text files

Remarks

The configuration string contains connection and configuration information specific to the provider. Each provider has configuration settings that are unique to that provider, and these properties are set using the ConfigString property.

The following table lists the available log providers, their description, and their ConfigString information.

Provider	Description	ConfigString property
SQL Server Profiler	Generates SQL traces that may be captured and viewed in SQL Server Profiler. The default file name extension for this provider is .trc.	No configuration is required.
SQL Server	Writes event log entries to the sysssislog table in any SQL Server database.	SQL Server provider requires that the connection to the database be specified, and also the target database name.
Text File	Writes event log entries to ASCII text files in a comma-separated value (CSV) format. The default file name extension for this provider is .log.	The name of a file connection manager.
Windows Event Log	Logs to standard Windows Event Log on the local computer in the Application log.	No configuration is required.
XML File	Writes event log entries to XML formatted file. The default file name extension for this provider is .xml	The name of the XML connection manager.