Share via

  • 项目

TaskHost 类

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.

命名空间：  Microsoft.SqlServer.Dts.Runtime
程序集：  Microsoft.SqlServer.ManagedDTS（在 Microsoft.SqlServer.ManagedDTS.dll 中）

语法

声明
Public NotInheritable Class TaskHost _
    Inherits EventsProvider _
    Implements IDTSObjectHost, IDTSPropertiesProvider, IDTSPackagePath
用法
Dim instance As TaskHost

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

public ref class TaskHost sealed : public EventsProvider, 
    IDTSObjectHost, IDTSPropertiesProvider, IDTSPackagePath

[<SealedAttribute>]
type TaskHost =  
    class
        inherit EventsProvider
        interface IDTSObjectHost
        interface IDTSPropertiesProvider
        interface IDTSPackagePath
    end

public final class TaskHost extends EventsProvider implements IDTSObjectHost, IDTSPropertiesProvider, IDTSPackagePath

TaskHost 类型公开以下成员。

属性

  名称 说明
公共属性 ApartmentThreaded 基础结构。
公共属性 CreationName Returns the string that is used to create an instance of the DtsContainer object. This property is read-only. （从 DtsContainer 继承。）
公共属性 DebugMode 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. （从 DtsContainer 继承。）
公共属性 DelayValidation Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false. （从 DtsContainer 继承。）
公共属性 Description Gets or sets the description of the DtsContainer object. （从 DtsContainer 继承。）
公共属性 Disable A Boolean that indicates if the DtsContainer object is disabled. （从 DtsContainer 继承。）
公共属性 DisableEventHandlers Gets or sets a Boolean that indicates whether the event handlers on task are disabled. （从 EventsProvider 继承。）
公共属性 EventHandlers Returns a collection of event handler objects. This field is read-only. （从 EventsProvider 继承。）
公共属性 EventInfos Returns a collection of EventInfo objects. This field is read-only. （从 EventsProvider 继承。）
公共属性 ExecutionDuration Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. （从 DtsContainer 继承。）
公共属性 ExecutionResult Returns a value that indicates the success or failure of the execution of the DtsContainer object. （从 DtsContainer 继承。）
公共属性 ExecutionStatus Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call. （从 DtsContainer 继承。）
公共属性 ExecutionValue Returns the result of the task execution. This property is read-only.
公共属性 ExecValueVariable Gets or sets the custom Variable that contains the execution results of the task.
公共属性 FailPackageOnFailure 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. （从 DtsContainer 继承。）
公共属性 FailParentOnFailure Gets or sets a Boolean that defines whether the parent container fails when a child container fails. （从 DtsContainer 继承。）
公共属性 ForcedExecutionValue If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns. （从 DtsContainer 继承。）
公共属性 ForceExecutionResult Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. （从 DtsContainer 继承。）
公共属性 ForceExecutionValue Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value. （从 DtsContainer 继承。）
公共属性 HostType Gets a value from the DTSObjectHostType enumeration that describes the host of the container. This property is read-only.
公共属性 ID Returns the ID, which is a GUID, of the DtsContainer. The value is read-only. （从 DtsContainer 继承。）
公共属性 InnerObject The method used to access the task instance being hosted by the TaskHost.
公共属性 IsDefaultLocaleID A Boolean that indicates whether the container uses the default locale. This property is read-only. （从 DtsContainer 继承。）
公共属性 IsolationLevel Gets or sets the isolation level of the transaction in the DtsContainer object. （从 DtsContainer 继承。）
公共属性 LocaleID Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. （从 DtsContainer 继承。）
公共属性 LogEntryInfos Returns a LogEntryInfos object. This property is read-only. （从 DtsContainer 继承。）
公共属性 LoggingMode Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. （从 DtsContainer 继承。）
公共属性 LoggingOptions Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. （从 DtsContainer 继承。）
公共属性 MaximumErrorCount Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running. （从 DtsContainer 继承。）
公共属性 Name Gets or sets the name of the DtsContainer. （从 DtsContainer 继承。）
公共属性 Parent Returns the parent container. The value is read-only. （从 DtsContainer 继承。）
公共属性 Properties Returns a DtsProperties collection that contains the properties associated with the task.
公共属性 Site 基础结构。 （从 DtsContainer 继承。）
公共属性 StartTime Returns the time that the container began execution. This property is read-only. （从 DtsContainer 继承。）
公共属性 StopTime Returns the time that the container ended execution. This property is read-only. （从 DtsContainer 继承。）
公共属性 SuspendRequired 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. （从 DtsContainer 继承。）
公共属性 TransactionOption Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. （从 DtsContainer 继承。）
公共属性 VariableDispenser Returns a VariableDispenser object so variables associated with the container can be locked. （从 DtsContainer 继承。）
公共属性 Variables Returns a collection that contains the variables associated with this container. This property is read-only. （从 DtsContainer 继承。）

页首

方法

  名称 说明
公共方法 AcceptBreakpointManager 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. （从 DtsContainer 继承。）
公共方法 Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. （从 DtsContainer 继承。）
公共方法 Equals Determines whether two object instances are equal. （从 DtsObject 继承。）
公共方法 Execute Runs the application, container, or package as part of a package workflow. （从 DtsContainer 继承。）
受保护方法 Finalize （从 Object 继承。）
公共方法 GetExpression Returns the expression for the specified property. Null means no expression is assigned.
公共方法 GetHashCode Returns the hash code for this instance. （从 DtsObject 继承。）
公共方法 GetPackagePath Returns the path to the task location.
公共方法 GetType （从 Object 继承。）
公共方法 LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application..::..LoadPackage method. （从 DtsContainer 继承。）
受保护方法 MemberwiseClone （从 Object 继承。）
公共方法 ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. （从 DtsContainer 继承。）
公共方法 SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method. （从 DtsContainer 继承。）
公共方法 SetExpression Assigns the specified expression to the property. Specify nullNothingnullptrunitnull 引用（在 Visual Basic 中为 Nothing） to remove an existing expression from the property.
受保护方法 SetWrappedExecutable 基础结构。 （从 EventsProvider 继承。）
公共方法 SuspendExecution Called when the executable needs to suspend. This method is called by the runtime engine. （从 DtsContainer 继承。）
公共方法 ToString （从 Object 继承。）
公共方法 Validate Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. （从 DtsContainer 继承。）

页首

事件

  名称 说明
公共事件 Disposed Adds an event handler to listen to the Disposed event on the component. （从 DtsContainer 继承。）

页首

字段

  名称 说明
受保护字段 m_executable 基础结构。 （从 Executable 继承。）

页首

注释

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 容器.

示例

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());
            }
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.BulkInsertTask
Imports Microsoft.SqlServer.Dts.Tasks.FileSystemTask
 
Namespace Microsoft.SqlServer.SSIS.Samples
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim p As Package =  New Package() 
            ' Add a File System task to the package.
            Dim exec1 As Executable =  p.Executables.Add("STOCK:FileSystemTask") 
            Dim thFileSystemTask As TaskHost =  exec1 as TaskHost 
            ' Add a Bulk Insert task to the package.
            Dim exec2 As Executable =  p.Executables.Add("STOCK:BulkInsertTask") 
            Dim thBulkInsertTask As TaskHost =  exec2 as TaskHost 
 
            ' Iterate through the package Executables collection.
            Dim pExecs As Executables =  p.Executables 
            Dim pExec As Executable
            For Each pExec In pExecs
                Dim taskHost As TaskHost = CType(pExec, TaskHost)
                Console.WriteLine("Type {0}", taskHost.InnerObject.ToString())
            Next
        End Sub
    End Class
End Namespace

Sample Output:

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

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

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。