ConnectionInfo.Description Property

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

Assembly:: Microsoft.SqlServer.ManagedDTS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets a description for a connection.

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

Implements

Description

Examples

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\100\DTS\Binn\DtsConn.dll

0

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

DTS Connection Manager for Files

Microsoft.DataTransformationServices.Design.SingleFileConnectionManagerUI,

Microsoft.DataTransformationServices.Design, Version=10.0.000.0,

Culture=neutral, PublicKeyToken=89845dcd8080cc91

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.

Applies to

Share via