Export (0) Print
Expand All

TaskHost Class

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 ref class TaskHost sealed : public EventsProvider, 
	IDTSObjectHost, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath

The TaskHost type exposes the following members.

  NameDescription
Public propertyApartmentThreadedInfrastructure. Gets a value that indicates whether the task is an apartment-threaded object.
Public propertyCreationNameReturns the string that is used to create an instance of the DtsContainer object. This property is read-only. (Inherited from DtsContainer.)
Public propertyDebugModeGets 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.)
Public propertyDelayValidationGets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. (Inherited from DtsContainer.)
Public propertyDescriptionGets or sets the description of the DtsContainer object. (Inherited from DtsContainer.)
Public propertyDisableA Boolean that indicates if the DtsContainer object is disabled. (Inherited from DtsContainer.)
Public propertyDisableEventHandlersGets or sets a Boolean that indicates whether the event handlers on task are disabled. (Inherited from EventsProvider.)
Public propertyEventHandlersReturns a collection of event handler objects. This field is read-only. (Inherited from EventsProvider.)
Public propertyEventInfosReturns a collection of EventInfo objects. This field is read-only. (Inherited from EventsProvider.)
Public propertyExecutionDurationReturns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. (Inherited from DtsContainer.)
Public propertyExecutionResultReturns a value that indicates the success or failure of the execution of the DtsContainer object. (Inherited from DtsContainer.)
Public propertyExecutionStatusReturns a value that indicates the current status of the execution of the DtsContainer object at the time of the call. (Inherited from DtsContainer.)
Public propertyExecutionValueGets the result of the task execution. This property is read-only.
Public propertyExecValueVariableGets or sets the custom Variable that contains the execution results of the task.
Public propertyFailPackageOnFailureGets 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.)
Public propertyFailParentOnFailureGets or sets a Boolean that defines whether the parent container fails when a child container fails. (Inherited from DtsContainer.)
Public propertyForcedExecutionValueIf 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.)
Public propertyForceExecutionResultGets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (Inherited from DtsContainer.)
Public propertyForceExecutionValueGets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. (Inherited from DtsContainer.)
Public propertyHasExpressionsGets a value that indicates whether the TaskHost object has expressions.
Public propertyHostTypeGets a value from the DTSObjectHostType enumeration that describes the host of the container. This property is read-only.
Public propertyIDReturns the ID, which is a GUID, of the DtsContainer. The value is read-only. (Inherited from DtsContainer.)
Public propertyInnerObjectGets the method used to access the task instance being hosted by the TaskHost.
Public propertyIsDefaultLocaleIDA Boolean that indicates whether the container uses the default locale. This property is read-only. (Inherited from DtsContainer.)
Public propertyIsolationLevelGets or sets the isolation level of the transaction in the DtsContainer object. (Inherited from DtsContainer.)
Public propertyLocaleIDGets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (Inherited from DtsContainer.)
Public propertyLogEntryInfosReturns a LogEntryInfos object. This property is read-only. (Inherited from DtsContainer.)
Public propertyLoggingModeGets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. (Inherited from DtsContainer.)
Public propertyLoggingOptionsReturns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. (Inherited from DtsContainer.)
Public propertyMaximumErrorCountGets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running. (Inherited from DtsContainer.)
Public propertyNameGets or sets the name of the DtsContainer. (Inherited from DtsContainer.)
Public propertyParentReturns the parent container. The value is read-only. (Inherited from DtsContainer.)
Public propertyPropertiesGets a DtsProperties collection that contains the properties associated with the task.
Public propertySiteInfrastructure. Gets or sets the site for the container. (Inherited from DtsContainer.)
Public propertyStartTimeReturns the time that the container began execution. This property is read-only. (Inherited from DtsContainer.)
Public propertyStopTimeReturns the time that the container ended execution. This property is read-only. (Inherited from DtsContainer.)
Public propertySuspendRequiredGets 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.)
Public propertyTransactionOptionGets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. (Inherited from DtsContainer.)
Public propertyVariableDispenserReturns a VariableDispenser object so variables associated with the container can be locked. (Inherited from DtsContainer.)
Public propertyVariablesReturns a collection that contains the variables associated with this container. This property is read-only. (Inherited from DtsContainer.)
Top

  NameDescription
Public methodAcceptBreakpointManagerThis 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.)
Public methodComputeExpressionsComputes the expressions of the TaskHost object.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DtsContainer.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteRuns the application, container, or package as part of a package workflow. (Inherited from DtsContainer.)
Public methodGetExecutionPathReturns the execution path of the current TaskHost.
Public methodGetExpressionReturns the expression for the specified property. Null means no expression is assigned.
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetPackagePathReturns the path to the task location.
Public methodGetType (Inherited from Object.)
Public methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application::LoadPackage method. (Inherited from DtsContainer.)
Public methodResumeExecutionResumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Inherited from DtsContainer.)
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application::SaveToXml method. (Inherited from DtsContainer.)
Public methodSetExpressionAssigns the specified expression to the property. Specify nullptr to remove an existing expression from the property.
Public methodSuspendExecutionCalled when the executable needs to suspend. This method is called by the runtime engine. (Inherited from DtsContainer.)
Public methodToString (Inherited from Object.)
Public methodValidateAllows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from DtsContainer.)
Top

  NameDescription
Public eventDisposedAdds an event handler to listen to the Disposed event on the component. (Inherited from DtsContainer.)
Top

  NameDescription
Protected fieldm_executableInfrastructure. The executable. (Inherited from Executable.)
Top

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.

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.

No code example is currently available or this language may not be supported.

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.

Community Additions

ADD
Show:
© 2014 Microsoft