Export (0) Print
Expand All

IDTSName.Description Property

Gets or sets a description about the object.

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

string Description { get; set; }
/** @property */
String get_Description ()

/** @property */
void set_Description (String value)

function get Description () : String

function set Description (value : String)

Property Value

A String that contains information about the object.

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);
        }
    }
}

Sample Output:

CreationName: MSDTS.Package.1

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

Description:

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

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.

Development Platforms

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

Target Platforms

Community Additions

ADD
Show:
© 2014 Microsoft