Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

TaskHost Class

 

Applies To: SQL Server 2016 Preview

Provides a container that encapsulates a single task. In the SSIS Designer, the TaskHost is not configured separately; instead, it is configured when you set the properties of the task it encapsulates.

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


public sealed class TaskHost : EventsProvider, IDTSObjectHost, 
	IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, 
	IDTSExecutionPath

NameDescription
System_CAPS_pubpropertyApartmentThreaded

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates whether the task is an apartment-threaded object.

System_CAPS_pubpropertyCreationName

Returns the string that is used to create an instance of the DtsContainer object. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyDebugMode

Gets or sets a Boolean that indicates whether the DtsContainer object is in debug mode and whether it should fire the OnBreakpointHit event while running. (Inherited from DtsContainer.)

System_CAPS_pubpropertyDelayValidation

Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.(Inherited from DtsContainer.)

System_CAPS_pubpropertyDescription

Gets or sets the description of the DtsContainer object.(Inherited from DtsContainer.)

System_CAPS_pubpropertyDisable

A Boolean that indicates if the DtsContainer object is disabled. (Inherited from DtsContainer.)

System_CAPS_pubpropertyDisableEventHandlers

Gets or sets a Boolean that indicates whether the event handlers on task are disabled. (Inherited from EventsProvider.)

System_CAPS_pubpropertyEventHandlers

Returns a collection of event handler objects. This field is read-only.(Inherited from EventsProvider.)

System_CAPS_pubpropertyEventInfos

Returns a collection of EventInfo objects. This field is read-only.(Inherited from EventsProvider.)

System_CAPS_pubpropertyExecutionDuration

Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. (Inherited from DtsContainer.)

System_CAPS_pubpropertyExecutionResult

Returns a value that indicates the success or failure of the execution of the DtsContainer object. (Inherited from DtsContainer.)

System_CAPS_pubpropertyExecutionStatus

Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call.(Inherited from DtsContainer.)

System_CAPS_pubpropertyExecutionValue

Gets the result of the task execution. This property is read-only.

System_CAPS_pubpropertyExecValueVariable

Gets or sets the custom Variable that contains the execution results of the task.

System_CAPS_pubpropertyFailPackageOnFailure

Gets or sets a Boolean that indicates whether the package fails when a child container fails. This property is used on containers, not the package itself.(Inherited from DtsContainer.)

System_CAPS_pubpropertyFailParentOnFailure

Gets or sets a Boolean that defines whether the parent container fails when a child container fails.(Inherited from DtsContainer.)

System_CAPS_pubpropertyForcedExecutionValue

If the ForceExecutionValue property is set to True, gets or sets a value that specifies the optional execution value that the package returns.(Inherited from DtsContainer.)

System_CAPS_pubpropertyForceExecutionResult

Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (Inherited from DtsContainer.)

System_CAPS_pubpropertyForceExecutionValue

Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.(Inherited from DtsContainer.)

System_CAPS_pubpropertyHasExpressions

Gets a value that indicates whether the TaskHost object has expressions.

System_CAPS_pubpropertyHostType

Gets a value from the DTSObjectHostType enumeration that describes the host of the container. This property is read-only.

System_CAPS_pubpropertyID

Returns the ID, which is a GUID, of the DtsContainer. The value is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyInnerObject

Gets the method used to access the task instance being hosted by the TaskHost.

System_CAPS_pubpropertyIsDefaultLocaleID

A Boolean that indicates whether the container uses the default locale. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyIsolationLevel

Gets or sets the isolation level of the transaction in the DtsContainer object. (Inherited from DtsContainer.)

System_CAPS_pubpropertyLocaleID

Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (Inherited from DtsContainer.)

System_CAPS_pubpropertyLogEntryInfos

Returns a LogEntryInfos object. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyLoggingMode

Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.(Inherited from DtsContainer.)

System_CAPS_pubpropertyLoggingOptions

Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyMaximumErrorCount

Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running.(Inherited from DtsContainer.)

System_CAPS_pubpropertyName

Gets or sets the name of the DtsContainer.(Inherited from DtsContainer.)

System_CAPS_pubpropertyParent

Returns the parent container. The value is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyProperties

Gets a DtsProperties collection that contains the properties associated with the task.

System_CAPS_pubpropertySite

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the site for the container.(Inherited from DtsContainer.)

System_CAPS_pubpropertyStartTime

Returns the time that the container began execution. This property is read-only. (Inherited from DtsContainer.)

System_CAPS_pubpropertyStopTime

Returns the time that the container ended execution. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertySuspendRequired

Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.(Inherited from DtsContainer.)

System_CAPS_pubpropertyTransactionOption

Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.(Inherited from DtsContainer.)

System_CAPS_pubpropertyVariableDispenser

Returns a VariableDispenser object so variables associated with the container can be locked. (Inherited from DtsContainer.)

System_CAPS_pubpropertyVariables

Returns a collection that contains the variables associated with this container. This property is read-only.(Inherited from DtsContainer.)

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

This method is called by the run-time engine when a task or container is created, and passes it a BreakpointManager manager to allow the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.(Inherited from DtsContainer.)

System_CAPS_pubmethodComputeExpressions(Boolean)

Computes the expressions of the TaskHost object.

System_CAPS_pubmethodDispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from DtsContainer.)

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections, Variables, IDTSEvents, IDTSLogging, Object)

Runs the application, container, or package as part of a package workflow.(Inherited from DtsContainer.)

System_CAPS_pubmethodGetExecutionPath()

Returns the execution path of the current TaskHost.

System_CAPS_pubmethodGetExpression(String)

Returns the expression for the specified property. Null means no expression is assigned.

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetPackagePath()

Returns the path to the task location.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.(Inherited from DtsContainer.)

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Inherited from DtsContainer.)

System_CAPS_pubmethodSaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.(Inherited from DtsContainer.)

System_CAPS_pubmethodSetExpression(String, String)

Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

System_CAPS_pubmethodSuspendExecution()

Called when the executable needs to suspend. This method is called by the runtime engine. (Inherited from DtsContainer.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(Connections, Variables, IDTSEvents, IDTSLogging)

Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.(Inherited from DtsContainer.)

NameDescription
System_CAPS_protfieldm_executable

This API supports the product infrastructure and is not intended to be used directly from your code. The executable.(Inherited from Executable.)

NameDescription
System_CAPS_pubeventDisposed

Adds an event handler to listen to the Disposed event on the component.(Inherited from DtsContainer.)

Integration Services provides several different types of containers for building packages, with the TaskHost being one of those containers. The TaskHost container provides services to a single task. It does not have a matching item in the graphical designer toolbox. The TaskHost object is a wrapper object for the task, and is created transparently during task creation. It is returned from the Add method as an Executable object and is cast as a TaskHost. Finally, the task instance is accessed through the InnerObject property. For more information on all of the SSIS containers, see Integration Services Containers.

Legacy Code Example

The following code example shows the creation of an empty package. Two tasks are added to the package and cast into a TaskHost class, so TaskHost methods and properties can be used on either task , such as the InnerObject method, without regard to what kind of task it is.

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

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Package p = new Package();
            // Add a File System task to the package.
            Executable exec1 = p.Executables.Add("STOCK:FileSystemTask");
            TaskHost thFileSystemTask = exec1 as TaskHost;
            // Add a Bulk Insert task to the package.
            Executable exec2 = p.Executables.Add("STOCK:BulkInsertTask");
            TaskHost thBulkInsertTask = exec2 as TaskHost;

            // Iterate through the package Executables collection.
            Executables pExecs = p.Executables;
            foreach (Executable pExec in pExecs)
            {
                TaskHost taskHost = (TaskHost)pExec;
                Console.WriteLine("Type {0}", taskHost.InnerObject.ToString());
            }
        }
    }
}

Sample Output:

Type Microsoft.SqlServer.Dts.Tasks.FileSystemTask.FileSystemTask

Type Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTask

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

Return to top

Community Additions

Show:
© 2015 Microsoft