LogEntryInfo.Description Property

Gets or sets the description for the log entry.

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 LogEntryInfo 
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 a description.

Implements

IDTSName.Description

Examples

The following code example iterates over the LogEntryInfos collection, and then prints the properties of each LogEntryInfo found, including Description.

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

namespace LogEntryInfosTest
{
    class Program
    {
        static void Main(string[] args)
        {
            // The package is one of the SSIS Samples.
            string mySample = @"C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx";

            Application app = new Application();
            Package pkg = app.LoadPackage(mySample, null);
            LogEntryInfos logInfos = pkg.LogEntryInfos;

            Console.WriteLine("Number of log entries:  {0}", logInfos.Count.ToString());
            foreach (LogEntryInfo logInfo in logInfos)
            {
                Console.WriteLine("CreationName:   {0}", logInfo.CreationName);
                Console.WriteLine("Description:    {0}", logInfo.Description);
                Console.WriteLine("FrequencyHint:  {0}", logInfo.FrequencyHint);
                Console.WriteLine("ID:             {0}", logInfo.ID);
                Console.WriteLine("Name:           {0}", logInfo.Name);
            }
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace LogEnTryInfosTest
    Class Program
        Shared  Sub Main(ByVal args() As String)
            ' The package is one of the SSIS Samples.
            Dim mySample As String =  "C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx" 
 
            Dim app As Application =  New Application() 
            Dim pkg As Package =  app.LoadPackage(mySample,Nothing) 
            Dim logInfos As LogEnTryInfos =  pkg.LogEnTryInfos 
 
            Console.WriteLine("Number of log entries:  {0}", logInfos.Count.ToString())
            Dim logInfo As LogEnTryInfo
            For Each logInfo In logInfos
                Console.WriteLine("CreationName:   {0}", logInfo.CreationName)
                Console.WriteLine("Description:    {0}", logInfo.Description)
                Console.WriteLine("FrequencyHint:  {0}", logInfo.FrequencyHint)
                Console.WriteLine("ID:             {0}", logInfo.ID)
                Console.WriteLine("Name:           {0}", logInfo.Name)
            Next
        End Sub
    End Class
End Namespace

Sample Output:

Number of log entries: 1

CreationName:

Description: Logs package diagnostics information, e.g. maximum concurrent executables

FrequencyHint: Consistent

ID: {65F44252-EB0C-4CCB-ADE4-BA4AB86B4CF9}

Name: Diagnostic

See Also

Reference

LogEntryInfo Class

Microsoft.SqlServer.Dts.Runtime Namespace