• Article

LogProviderInfo.Description Property

Returns the description for the log provider. This property is read-only.

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 LogProviderInfo
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 log provider description.

Implements

IDTSName.Description

Examples

The following code example retrieves and iterates through all the properties of each log provider in the log provider collection, and then prints out the values, including the value for Description.

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

namespace LogProvInfoProperties
{
    class Program
    {
        static void Main(string[] args)
        {
        Application app = new Application();
        LogProviderInfos infos = app.LogProviderInfos;
 
        foreach(LogProviderInfo info in infos)
          {
            Console.WriteLine("CreationName           {0}", info.CreationName);
            Console.WriteLine("Description            {0}", info.Description);
            Console.WriteLine("FileName:              {0}", info.FileName);
            //Console.WriteLine("FileNameVersionString: {0}", info.FileNameVersionString);
            Console.WriteLine("IconFile:              {0}", info.IconFile);
            Console.WriteLine("IconResource:          {0}", info.IconResource);
            Console.WriteLine("ID:                    {0}", info.ID);
            Console.WriteLine("LogProviderContact     {0}", info.LogProviderContact);
            Console.WriteLine("LogProviderType        {0}", info.LogProviderType);
            Console.WriteLine("Name:                  {0}", info.Name);
            Console.WriteLine("UITypeName             {0}", info.UITypeName); 
            Console.WriteLine("__________________________");
           
          }
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace LogProvInfoProperties
    Class Program
        Shared  Sub Main(ByVal args() As String)
        Dim app As Application =  New Application() 
        Dim infos As LogProviderInfos =  app.LogProviderInfos 
 
        Dim info As LogProviderInfo
        For Each info In infos
            Console.WriteLine("CreationName           {0}", info.CreationName)
            Console.WriteLine("Description            {0}", info.Description)
            Console.WriteLine("FileName:              {0}", info.FileName)
            'Console.WriteLine("FileNameVersionString: {0}", info.FileNameVersionString)
            Console.WriteLine("IconFile:              {0}", info.IconFile)
            Console.WriteLine("IconResource:          {0}", info.IconResource)
            Console.WriteLine("ID:                    {0}", info.ID)
            Console.WriteLine("LogProviderContact     {0}", info.LogProviderContact)
            Console.WriteLine("LogProviderType        {0}", info.LogProviderType)
            Console.WriteLine("Name:                  {0}", info.Name)
            Console.WriteLine("UITypeName             {0}", info.UITypeName) 
            Console.WriteLine("__________________________")
 
        Next
        End Sub
    End Class
End Namespace

Sample Output:

CreationName DTS.LogProviderTextFile.2

Description Writes log entries for events to a CSV file

FileName: C:\Program Files\Microsoft SQL Server\100\DTS\Binn\DTSLog.dll

IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\Binn\DTSLog.dll

IconResource: 0

ID: {59B2C6A5-663F-4C20-8863-C83F9B72E2EB}

LogProviderContact

LogProviderType DTS10

Name: SSIS log provider for Text files

UITypeName Microsoft.DataTransformationServices.Design.FileConnectionsLogProviderUI, Microsoft.DataTransformationServices.Design, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

CreationName DTS.LogProviderSQLProfiler.2

Description Generates SQL traces that may be captured in SQL Server Profiler

FileName: C:\Program Files\Microsoft SQL Server\100\DTS\Binn\DTSLog.dll

IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\Binn\DTSLog.dll

IconResource: 0

ID: {5C0B8D21-E9AA-462E-BA34-30FF5F7A42A1}

LogProviderContact

LogProviderType DTS10

Name: SSIS log provider for SQL Server Profiler

UITypeName Microsoft.DataTransformationServices.Design.FileConnectionsLogProviderUI, Microsoft.DataTransformationServices.Design, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91

CreationName DTS.LogProviderSQLServer.2

Description Writes log entries for events to a SQL Server database

FileName: C:\Program Files\Microsoft SQL Server\100\DTS\Binn\DTSLog.dll

IconFile: C:\Program Files\Microsoft SQL Server\100\DTS\Binn\DTSLog.dll

IconResource: 0

ID: {6AA833A1-E4B2-4431-831B-DE695049DC61}

LogProviderContact

LogProviderType DTS10

Name: SSIS log provider for SQL Server

UITypeName Microsoft.DataTransformationServices.Design.OleDbConnectionsLogProviderUI, Microsoft.DataTransformationServices.Design, Version=10.0.000.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91