TaskInfo.Description Property
Gets or sets a description for the task.
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 task description.
Example
The following code retrieves the TaskInfos collection from the application, iterates through each property of each TaskInfo in the collection, and then prints the values of each property, including the Description.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
namespace TaskType
{
class Program
{
static void Main(string[] args)
{
Application myApp = new Application();
TaskInfos tInfos = myApp.TaskInfos;
// Iterate through the collection,
// printing values for the properties.
foreach (TaskInfo tInfo in tInfos)
{
Console.WriteLine("CreationName: {0}", tInfo.CreationName);
Console.WriteLine("Description {0}", tInfo.Description);
Console.WriteLine("FileName {0}", tInfo.FileName);
// Console.WriteLine("FileNameVersionString {0}", tInfo.FileNameVersionString);
Console.WriteLine("IconFile {0}", tInfo.IconFile);
Console.WriteLine("IconResource {0}", tInfo.IconResource);
Console.WriteLine("ID {0}", tInfo.ID);
Console.WriteLine("Name {0}", tInfo.Name);
// Console.WriteLine("TaskContact {0}", tInfo.TaskContact);
Console.WriteLine("TaskType {0}", tInfo.TaskType);
Console.WriteLine("UITypeName {0}", tInfo.UITypeName);
Console.WriteLine("----------------------------");
}
Console.WriteLine();
}
}
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Namespace TaskType
_
Class Program
'Entry point which delegates to C-style main Private Function
Public Overloads Shared Sub Main()
Main(System.Environment.GetCommandLineArgs())
End Sub
Overloads Shared Sub Main(args() As String)
Dim myApp As New Application()
Dim tInfos As TaskInfos = myApp.TaskInfos
' Iterate through the collection,
' printing values for the properties.
Dim tInfo As TaskInfo
For Each tInfo In tInfos
Console.WriteLine("CreationName: {0}", tInfo.CreationName)
Console.WriteLine("Description {0}", tInfo.Description)
Console.WriteLine("FileName {0}", tInfo.FileName)
' Console.WriteLine("FileNameVersionString {0}", tInfo.FileNameVersionString)
Console.WriteLine("IconFile {0}", tInfo.IconFile)
Console.WriteLine("IconResource {0}", tInfo.IconResource)
Console.WriteLine("ID {0}", tInfo.ID)
Console.WriteLine("Name {0}", tInfo.Name)
' Console.WriteLine("TaskContact {0}", tInfo.TaskContact)
Console.WriteLine("TaskType {0}", tInfo.TaskType)
Console.WriteLine("UITypeName {0}", tInfo.UITypeName)
Console.WriteLine("----------------------------")
Next tInfo
Console.WriteLine()
End Sub 'Main
End Class 'Program
End Namespace 'TaskType
Sample Output:
CreationName: Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTask, Microsoft.S
qlServer.ScriptTask, Version=9.0.242.0, Culture=neutral, PublicKeyToken=89845dcd
8080cc91
Description Provides interactive custom task authoring
FileName Microsoft.SqlServer.ScriptTask
FileNameVersionString 9.0.242.0
IconFile Microsoft.SqlServer.ScriptTask
IconResource TaskIcon
ID Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTask, Microsoft.S
qlServer.ScriptTask, Version=9.0.242.0, Culture=neutral, PublicKeyToken=89845dcd
8080cc91
Name Script Task
TaskContact
TaskType DTS90
UITypeName Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft
.SqlServer.ScriptTaskUI, Version=9.00.242.00, Culture=Neutral, PublicKeyToken=89
845dcd8080cc91
----------------------------
CreationName: Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTask, Microso
ft.SqlServer.SendMailTask, Version=9.0.242.0, Culture=neutral, PublicKeyToken=89
845dcd8080cc91
Description Sends an e-mail message.
FileName Microsoft.SqlServer.SendMailTask
FileNameVersionString 9.0.242.0
IconFile Microsoft.SqlServer.SendMailTask
IconResource TaskIcon
ID Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTask, Microso
ft.SqlServer.SendMailTask, Version=9.0.242.0, Culture=neutral, PublicKeyToken=89
845dcd8080cc91
Name Send Mail Task
TaskContact Send Mail Task; Microsoft Corporation; Microsoft SQL Server v9;
c 2004 Microsoft Corporation; All Rights Reserved;https://www.microsoft.com/sql/s
upport/default.asp;1
TaskType DTS90
UITypeName Microsoft.SqlServer.Dts.Tasks.SendMailTask.SendMailTaskUI, Micro
soft.SqlServer.SendMailTaskUI, Version=9.00.242.00, Culture=Neutral, PublicKeyTo
ken=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
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
See Also
Reference
TaskInfo Class
TaskInfo Members
Microsoft.SqlServer.Dts.Runtime Namespace