Partilhar via

EventInfo.Description Property

  • Artigo

Gets or sets the description for the EventInfo.

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 the description.

Example

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.

====

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

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