TaskInfo Class

Article
04/26/2013

Contains information about a task installed on the local computer.

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Dts.Runtime.DtsObject
Microsoft.SqlServer.Dts.Runtime.TaskInfo

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

Syntax

'Declaration
Public NotInheritable Class TaskInfo _
    Inherits DtsObject _
    Implements IDTSName
'Usage
Dim instance As TaskInfo

public sealed class TaskInfo : DtsObject, 
    IDTSName

public ref class TaskInfo sealed : public DtsObject, 
    IDTSName

[<SealedAttribute>]
type TaskInfo =  
    class 
        inherit DtsObject 
        interface IDTSName 
    end

public final class TaskInfo extends DtsObject implements IDTSName

The TaskInfo type exposes the following members.

Properties

	Name	Description
	CreationName	Returns the string used by the runtime to create an instance of the TaskInfo object and add the object to the TaskInfos collection. This property is read-only.
	Description	Gets or sets a description for the task.
	FileName	Returns the name of the task. This property is read-only.
	FileNameVersionString	Returns the version of the implementation file. This property is read-only.
	HelpCollection	Gets the help collection from which to retrieve the help.
	HelpKeyword	Gets the help keyword for the task information.
	IconFile	Returns the fully qualified name of the file that holds the icon for the task. This property is read-only.
	IconResource	The name of the .resource file or the .resx file that contains the icon to use when representing this task in the graphical user interface. This value is read-only.
	ID	Returns the GUID used when creating the task. This property is read-only.
	Name	Gets or sets the task name.
	SamplesTag	Gets the samples tag for the TaskInfo.
	TaskContact	Returns the contact information for the task. This property is read-only.
	TaskType	Returns a String that describes the type of task. This property is read-only.
	UITypeName	Returns the assembly that implements the user interface for the task. This value is read-only.

Top

Methods

	Name	Description
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Remarks

A TaskInfo object describes a task that is installed on the computer and that clients can instantiate. The registered task classes include those provided with Microsoft SQL Server and custom tasks provided by other vendors and implemented by users.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via