Export (0) Print
Expand All

ConnectionManager.Description Property

Gets or sets the description of the ConnectionManager object.

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

'Declaration
Public Property Description As String 
	Get 
	Set
'Usage
Dim instance As ConnectionManager 
Dim value As String 

value = instance.Description

instance.Description = value

Property Value

Type: String
A String that contains the description given to the connection manager.

Implements

IDTSName.Description

The following code example creates a new FILE connection manager and sets several properties, including the Description.

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.FileSystemTask
 
Namespace FileSystemTask_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim sourceDir As String =  "C:\TestFolder" 
            Dim pkg As Package =  New Package() 
 
            ' Create a File connection manager.
            Dim cm As ConnectionManager =  pkg.Connections.Add("FILE") 
            cm.Name = "The FILE connection manager"
            cm.Description = "My FILE connection manager"
            cm.ConnectionString = sourceDir
            cm.Properties("FileUsageType").SetValue(cm, DTSFileConnectionUsageType.FolderExists)
        End Sub
    End Class
End Namespace

Community Additions

ADD
Show:
© 2014 Microsoft