• Article

Classe 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.

Espace de noms :  Microsoft.SqlServer.Dts.Runtime
Assembly :  Microsoft.SqlServer.ManagedDTS (en Microsoft.SqlServer.ManagedDTS.dll)

Syntaxe

'Déclaration
Public NotInheritable Class TaskHost _
    Inherits EventsProvider _
    Implements IDTSObjectHost, IDTSPropertiesProvider, IDTSPackagePath
'Utilisation
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

Le type TaskHost expose les membres suivants.

Propriétés

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

Haut de la page

Méthodes

  Nom Description
Méthode publique 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. (hérité de DtsContainer.)
Méthode publique Dispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (hérité de DtsContainer.)
Méthode publique Equals Determines whether two object instances are equal. (hérité de DtsObject.)
Méthode publique Execute Runs the application, container, or package as part of a package workflow. (hérité de DtsContainer.)
Méthode protégée Finalize (hérité de Object.)
Méthode publique GetExpression Returns the expression for the specified property. Null means no expression is assigned.
Méthode publique GetHashCode Returns the hash code for this instance. (hérité de DtsObject.)
Méthode publique GetPackagePath Returns the path to the task location.
Méthode publique GetType (hérité de Object.)
Méthode publique LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application..::..LoadPackage method. (hérité de DtsContainer.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (hérité de DtsContainer.)
Méthode publique SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application..::..SaveToXml method. (hérité de DtsContainer.)
Méthode publique SetExpression Assigns the specified expression to the property. Specify nullNothingnullptrunitune référence Null (Nothing dans Visual Basic) to remove an existing expression from the property.
Méthode protégée SetWrappedExecutable Infrastructure. (hérité de EventsProvider.)
Méthode publique SuspendExecution Called when the executable needs to suspend. This method is called by the runtime engine. (hérité de DtsContainer.)
Méthode publique ToString (hérité de Object.)
Méthode publique Validate Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (hérité de DtsContainer.)

Haut de la page

Événements

  Nom Description
Événement public Disposed Adds an event handler to listen to the Disposed event on the component. (hérité de DtsContainer.)

Haut de la page

Champs

  Nom Description
Champ protégé m_executable Infrastructure. (hérité de Executable.)

Haut de la page

Notes

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 Conteneurs Integration Services.

Exemples

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.