Dela via


LogProvider.Description Property

Gets or sets the description of the LogProvider object.

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public Property Description As String
    Get
    Set
'Usage
Dim instance As LogProvider
Dim value As String

value = instance.Description

instance.Description = value
public string Description { get; set; }
public:
virtual property String^ Description {
    String^ get () sealed;
    void set (String^ value) sealed;
}
abstract Description : string with get, set
override Description : string with get, set
final function get Description () : String
final function set Description (value : String)

Property Value

Type: System.String
A String that contains the description of the LogProvider.

Implements

IDTSName.Description

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 Description.

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.2

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