Partilhar via


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
public string Description { get; set; }
public:
virtual property String^ Description {
    String^ get () sealed;
    void set (String^ value) sealed;
}
/** @property */
public final String get_Description ()

/** @property */
public final void set_Description (String value)
public final function get Description () : String

public final function set Description (value : String)

Property Value

A String that contains a description.

Example

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\90\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\90\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

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

LogEntryInfo Class
LogEntryInfo Members
Microsoft.SqlServer.Dts.Runtime Namespace