IDTSName.Description Property

Applies To: SQL Server 2016 Preview

Gets or sets a description about the object.

Namespace:   Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

string Description { get; set; }

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

abstract Description : string with get, set

Property Description As String

Property Value

Type: System.String

A String that contains information about the object.

Examples

Legacy Code Example

The IDTSName class is inherited by many classes, including the Package class, through the DtsContainer class and into the EventsProvider class, which from there, it is inherited into the Package class and most other classes. The following code sample shows the IDTSName properties as used by the Package class.

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

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Package pkg = new Package();
            // Display the properties inherited from IDTSName.
            Console.WriteLine("CreationName: {0}", pkg.CreationName);
            Console.WriteLine("Name:         {0}", pkg.Name);
            Console.WriteLine("Description: {0}", pkg.Description);
            Console.WriteLine("ID:          {0}", pkg.ID);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace Microsoft.SqlServer.SSIS.Samples
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim pkg As Package =  New Package() 
            ' Display the properties inherited from IDTSName.
            Console.WriteLine("CreationName: {0}", pkg.CreationName)
            Console.WriteLine("Name:         {0}", pkg.Name)
            Console.WriteLine("Description: {0}", pkg.Description)
            Console.WriteLine("ID:          {0}", pkg.ID)
        End Sub
    End Class
End Namespace

Sample Output:

CreationName: MSDTS.Package.1

Name: {8E2F8EC1-A6E8-4114-8760-0C1A72277B8C}

Description:

ID: {8E2F8EC1-A6E8-4114-8760-0C1A72277B8C}

See Also

IDTSName Interface
Microsoft.SqlServer.Dts.Runtime Namespace

Return to top