ConnectionInfo.Description Property

Artykuł
12/03/2008

Gets or sets a description for a connection.

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 connection's description.

Remarks

In the graphical user interface for the SSIS Designer, this property is commonly shown in the Description property for each connection. This property is not required; however, it is useful to have descriptions.

Example

The following code example creates an Application object, iterates through the default connections on the computer and then lists the properties of each connection. In this example, the Description is shown as "Connection Manager for Files".

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

namespace ConnInfoTest
{
    class Program
    {
        static void Main(string[] args)
        {
            Application dtsApplication = new Application();
            ConnectionInfos connectionInfos = dtsApplication.ConnectionInfos;

            foreach (ConnectionInfo connInfo in connectionInfos)
            {
                Console.WriteLine(connInfo.ConnectionContact);
                Console.WriteLine(connInfo.ConnectionType);
                Console.WriteLine(connInfo.CreationName);
                Console.WriteLine(connInfo.Description);
                Console.WriteLine(connInfo.FileName);
                Console.WriteLine(connInfo.FileNameVersionString);
                Console.WriteLine(connInfo.IconFile);
                Console.WriteLine(connInfo.IconResource);
                Console.WriteLine(connInfo.ID);
                Console.WriteLine(connInfo.Name);
                Console.WriteLine(connInfo.UITypeName);
            }
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace ConnInfoTest
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim dtsApplication As Application =  New Application() 
            Dim connectionInfos As ConnectionInfos =  dtsApplication.ConnectionInfos 
 
            Dim connInfo As ConnectionInfo
            For Each connInfo In connectionInfos
                Console.WriteLine(connInfo.ConnectionContact)
                Console.WriteLine(connInfo.ConnectionType)
                Console.WriteLine(connInfo.CreationName)
                Console.WriteLine(connInfo.Description)
                Console.WriteLine(connInfo.FileName)
                Console.WriteLine(connInfo.FileNameVersionString)
                Console.WriteLine(connInfo.IconFile)
                Console.WriteLine(connInfo.IconResource)
                Console.WriteLine(connInfo.ID)
                Console.WriteLine(connInfo.Name)
                Console.WriteLine(connInfo.UITypeName)
            Next
        End Sub
    End Class
End Namespace

Sample Output:

Microsoft Corporation

FILE

DTS.ConnectionManagerFile.1

Connection Manager for Files

C:\Program Files\Microsoft SQL Server\90\DTS\Binn\DtsConn.dll

2000.90.1049.0

C:\Program Files\Microsoft SQL Server\90\DTS\Binn\DtsConn.dll

{41F5EFE4-E91A-4EB0-BF10-D40FD48B3C03}

DTS Connection Manager for Files

Microsoft.DataTransformationServices.Design.SingleFileConnectionManagerUI,

Microsoft.DataTransformationServices.Design, Version=9.0.242.0,

Culture=neutral, PublicKeyToken=89845dcd8080cc91

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