EventInfo.Description Property

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Gets or sets the description for the EventInfo.

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

public string Description { get; set; }

member this.Description : string with get, set

Public Property Description As String

Property Value

String

A String that contains the description.

Implements

Description

Examples

The following code sample returns the properties of the EventInfo class, including the Description.

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

namespace Runtime_API  
{  
    public class DumpEventInfo  
    {  
        static void Main(string[] args)  
        {  
            Package p = new Package();  
            EventInfos eis = p.EventInfos;  
            foreach (EventInfo ei in eis)  
            {  
                Console.Out.Write("Name: ");  
                Console.Out.WriteLine(ei.Name);  
                Console.Out.Write("Creation Name: ");  
                Console.Out.WriteLine(ei.CreationName);  
                Console.Out.Write("Description: ");  
                Console.Out.WriteLine(ei.Description);  
                Console.Out.WriteLine("====");  
            }  
        }  
    }  
}  

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

Namespace Runtime_API  
    Public Class DumpEventInfo  
        Shared  Sub Main(ByVal args() As String)  
            Dim p As Package =  New Package()   
            Dim eis As EventInfos =  p.EventInfos   
            Dim ei As EventInfo  
            For Each ei In eis  
                Console.Out.Write("Name: ")  
                Console.Out.WriteLine(ei.Name)  
                Console.Out.Write("Creation Name: ")  
                Console.Out.WriteLine(ei.CreationName)  
                Console.Out.Write("Description: ")  
                Console.Out.WriteLine(ei.Description)  
                Console.Out.WriteLine("====")  
            Next  
        End Sub  
    End Class  
End Namespace  

Sample Output:

Name: OnError

Creation Name: OnError

Description: Handles error events. Use to define actions to perform when an error occurs.

====

Name: OnExecStatusChanged

Creation Name: OnExecStatusChanged

Description: Handles changes of execution status. Use to define actions to perform when the execution status changes.

====

Name: OnInformation

Creation Name: OnInformation

Description: Handles information events. The menings of information events are task-defined and task-specific.

====

Name: OnPostExecute

Creation Name: OnPostExecute

Description: Handles post-execution events. Use to define post-processing actions to perform when the package is run.

====

Name: OnPostValidate

Creation Name: OnPostValidate

Description: Handles post-validation events. Use to define post-processing actions to perform during validation.

====