This topic has not yet been rated - Rate this topic

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)

Syntax

C++

JScript

Copy

public string Description { get; set; }

Property Value

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

Implements

IDTSName.Description

Examples

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

Copy

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

namespace FileSystemTask_API
{
    class Program
    {
        static void Main(string[] args)
        {
            String sourceDir = @"C:\TestFolder";
            Package pkg = new Package();
 
            // Create a File connection manager.
            ConnectionManager cm = 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);
        }
    }
}

Reference

ConnectionManager Class

Microsoft.SqlServer.Dts.Runtime Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)