TaskHost Klasse

Definition

Stellt einen Container bereit, der einen einzelnen Task kapselt. Im SSIS-Designer wird TaskHost nicht separat konfiguriert; die Konfiguration findet statt, wenn Sie die Eigenschaften des gekapselten Tasks festlegen.

public ref class TaskHost sealed : Microsoft::SqlServer::Dts::Runtime::EventsProvider, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSObjectHost, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx
public sealed class TaskHost : Microsoft.SqlServer.Dts.Runtime.EventsProvider, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSObjectHost, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx
type TaskHost = class
    inherit EventsProvider
    interface IDTSObjectHost
    interface IDTSPropertiesProvider
    interface IDTSPropertiesProviderEx
    interface IDTSPackagePath
    interface IDTSExecutionPath
Public NotInheritable Class TaskHost
Inherits EventsProvider
Implements IDTSExecutionPath, IDTSObjectHost, IDTSPackagePath, IDTSPropertiesProvider, IDTSPropertiesProviderEx
Vererbung
Implementiert

Beispiele

Das folgende Codebeispiel zeigt die Erstellung eines leeren Pakets. Zwei Aufgaben werden dem Paket hinzugefügt und in eine TaskHost Klasse umgewandelt, sodass TaskHost Methoden und Eigenschaften für beide Vorgänge verwendet werden können, z. B. die InnerObject Methode, ohne welche Art von Aufgabe es sich handelt.

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  

Beispielausgabe:

Typ Microsoft.SqlServer.Dts.Tasks.FileSystemTask.FileSystemTask

Typ Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTask

Hinweise

Integration Services bietet verschiedene Arten von Containern für das Erstellen von Paketen, wobei es TaskHost sich um einen dieser Container ist. Der TaskHost Container stellt Dienste für einen einzelnen Vorgang bereit. Es verfügt nicht über ein passendes Element in der Grafischen Designer-Toolbox. Das TaskHost Objekt ist ein Wrapperobjekt für die Aufgabe und wird während der Aufgabenerstellung transparent erstellt. Es wird von der Add Methode als Executable Objekt zurückgegeben und wird als ein TaskHostObjekt umgewandelt. Schließlich wird über die Eigenschaft auf die InnerObject Aufgabeninstanz zugegriffen. Weitere Informationen zu allen SSIS-Containern finden Sie unter Integration Services-Container.

Felder

m_executable

Die ausführbare Datei.

(Geerbt von Executable)

Eigenschaften

ApartmentThreaded

Ruft einen Wert ab, der angibt, ob der Task ein Apartmentthreadobjekt ist.

CreationName

Gibt die Zeichenfolge zurück, die zum Erstellen einer Instanz des DtsContainer-Objekts verwendet wird. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von DtsContainer)
DebugMode

Ruft einen booleschen Wert ab, der angibt, ob sich das DtsContainer Objekt im Debugmodus befindet und ob das OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) Ereignis beim Ausführen ausgelöst werden soll, oder legt diesen fest.

(Geerbt von DtsContainer)
DelayValidation

Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Überprüfung der Aufgabe bis zur Laufzeit verzögert wird. Der Standardwert ist „FALSE“.

(Geerbt von DtsContainer)
Description

Ruft die Beschreibung des DtsContainer-Objekts ab oder legt sie fest.

(Geerbt von DtsContainer)
Disable

Ein boolescher Wert, der angibt, ob das DtsContainer Objekt deaktiviert ist.

(Geerbt von DtsContainer)
DisableEventHandlers

Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob die Ereignishandler für den Vorgang deaktiviert sind.

(Geerbt von EventsProvider)
EventHandlers

Gibt eine Auflistung von Ereignishandlerobjekten zurück. Dieses Feld ist schreibgeschützt.

(Geerbt von EventsProvider)
EventInfos

Gibt eine Auflistung von EventInfo-Objekten zurück. Dieses Feld ist schreibgeschützt.

(Geerbt von EventsProvider)
ExecutionDuration

Gibt einen Wert zurück, der die Zeitdauer für die Ausführung des Containers in Millisekunden angibt. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von DtsContainer)
ExecutionResult

Gibt einen Wert zurück, der angibt, ob die Ausführung des DtsContainer-Objekts erfolgreich oder fehlerhaft war.

(Geerbt von DtsContainer)
ExecutionStatus

Gibt einen Wert zurück, der den aktuellen Ausführungsstatus des DtsContainer-Objekts zur Zeit des Aufrufs angibt.

(Geerbt von DtsContainer)
ExecutionValue

Ruft das Ergebnis der Taskausführung ab. Diese Eigenschaft ist schreibgeschützt.

ExecValueVariable

Ruft die benutzerdefinierte Variable ab, die die Ausführungsergebnisse des Tasks enthält, oder legt sie fest.

FailPackageOnFailure

Ruft einen booleschen Wert ab, der angibt, ob das Paket fehlschlägt, wenn ein untergeordneter Container fehlschlägt, oder legt diesen fest. Diese Eigenschaft wird für Container, nicht aber das Paket selbst verwendet.

(Geerbt von DtsContainer)
FailParentOnFailure

Ruft einen Boolean Wert ab, der definiert, ob der übergeordnete Container einen Fehler verursacht, wenn ein untergeordneter Container fehlerhaft war, oder legt ihn fest.

(Geerbt von DtsContainer)
ForcedExecutionValue

Wenn die ForceExecutionValue Eigenschaft auf True festgelegt ist, ruft einen Wert ab oder legt diesen fest, der den optionalen Ausführungswert angibt, den das Paket zurückgibt.

(Geerbt von DtsContainer)
ForceExecutionResult

Ruft einen DTSForcedExecResult-Enumerationswert ab, der das erzwungene Ausführungsergebnis des Containers angibt, oder legt ihn fest.

(Geerbt von DtsContainer)
ForceExecutionValue

Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob der Ausführungswert des Containers gezwungen werden soll, einen bestimmten Wert zu enthalten.

(Geerbt von DtsContainer)
HasExpressions

Ruft einen Wert ab, der angibt, ob das TaskHost-Objekt Ausdrücke enthält.

HostType

Ruft einen Wert aus der DTSObjectHostType-Enumeration ab, der den Host des Containers beschreibt. Diese Eigenschaft ist schreibgeschützt.

ID

Gibt die ID von DtsContainer zurück. Die ID ist eine GUID. Der Wert ist schreibgeschützt.

(Geerbt von DtsContainer)
InnerObject

Ruft die Methode für den Zugriff auf die von TaskHost gehostete Taskinstanz ab.

IsDefaultLocaleID

Ein boolescher Wert, der angibt, ob der Container das Standardgebietsschema verwendet. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von DtsContainer)
IsolationLevel

Ruft die Isolationsstufe der Transaktion im DtsContainer-Objekt ab oder legt sie fest.

(Geerbt von DtsContainer)
LocaleID

Ruft einen Integer-Wert ab, der die Microsoft Win32® LocaleID angibt, die verwendet werden soll, wenn das DtsContainer Objekt ausgeführt wird, oder legt diesen fest.

(Geerbt von DtsContainer)
LogEntryInfos

Gibt ein LogEntryInfos-Objekt zurück. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von DtsContainer)
LoggingMode

Ruft einen gültigen Wert aus der DTSLoggingMode-Enumeration ab, der den Protokollierungsmodus des Containers angibt, oder legt ihn fest.

(Geerbt von DtsContainer)
LoggingOptions

Gibt ein Objekt mit Eigenschaften zurück, die die Filterung und Protokollierung von Ressourcen für Container angeben. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von DtsContainer)
MaximumErrorCount

Dient zum Abrufen oder Festlegen eines Integer-Werts, der die maximale Anzahl von Fehlern angibt, die auftreten können, bevor das DtsContainer Objekt nicht mehr ausgeführt wird.

(Geerbt von DtsContainer)
Name

Ruft den Namen der DtsContainer ab oder legt diesen fest.

(Geerbt von DtsContainer)
Parent

Gibt den übergeordneten Container zurück. Der Wert ist schreibgeschützt.

(Geerbt von DtsContainer)
Properties

Ruft eine DtsProperties-Auflistung ab, die die dem Task zugeordneten Eigenschaften enthält.

Site

Ruft die Site für den Container ab oder legt sie fest.

(Geerbt von DtsContainer)
StartTime

Gibt die Uhrzeit zurück, zu der der Container die Ausführung gestartet hat. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von DtsContainer)
StopTime

Gibt die Uhrzeit zurück, zu der der Container die Ausführung beendet hat. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von DtsContainer)
SuspendRequired

Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob Vorgänge angehalten werden sollen, wenn ein Haltepunkt auftritt. Dieser Wert wird von der Runtime-Engine für Tasks und Container festgelegt, wenn ein Breakpoint erreicht wird.

(Geerbt von DtsContainer)
TransactionOption

Ruft einen DTSTransactionOption-Enumerationswert ab, der angibt, ob der Container an Transaktionen beteiligt ist, oder legt ihn fest.

(Geerbt von DtsContainer)
VariableDispenser

Gibt ein VariableDispenser-Objekt zurück, damit die dem Container zugeordneten Variablen gesperrt werden können.

(Geerbt von DtsContainer)
Variables

Gibt eine Auflistung zurück, die die diesem Container zugeordneten Variablen enthält. Diese Eigenschaft ist schreibgeschützt.

(Geerbt von DtsContainer)

Methoden

AcceptBreakpointManager(BreakpointManager)

Diese Methode wird von der Runtime-Engine aufgerufen, wenn ein Task oder Container erstellt wird, der an einen BreakpointManager-Manager übergeben wird, damit der Task Breakpoints erstellen, entfernen und deren Status überprüfen kann. Diese Methode wird von der Laufzeit aufgerufen und wird nicht in Code verwendet.

(Geerbt von DtsContainer)
ComputeExpressions(Boolean)

Berechnet die Ausdrücke des TaskHost-Objekts.

Dispose()

Führt anwendungsspezifische Aufgaben durch, die mit der Freigabe, der Zurückgabe oder dem Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen.

(Geerbt von DtsContainer)
Equals(Object)

Stellt fest, ob zwei Objektinstanzen gleich sind.

(Geerbt von DtsObject)
Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object)

Führt die Anwendung, den Container oder das Paket als Teil eines Paketworkflows aus.

(Geerbt von DtsContainer)
GetExecutionPath()

Gibt den Ausführungspfad des aktuellen TaskHost zurück.

GetExpression(String)

Gibt den Ausdruck für die angegebene Eigenschaft zurück. Null bedeutet, dass kein Ausdruck zugewiesen wird.

GetHashCode()

Gibt den Hashcode für diese Instanz zurück.

(Geerbt von DtsObject)
GetPackagePath()

Gibt den Pfad zum Taskspeicherort zurück.

LoadFromXML(XmlNode, IDTSEvents)

Diese Methode kann durch den Anwendungscode nicht aufgerufen werden. Um ein im XML-Format gespeichertes Paket zu laden, verwenden Sie die LoadPackage(String, IDTSEvents)-Methode.

(Geerbt von DtsContainer)
ResumeExecution()

Setzt die Taskausführung nach einer Unterbrechung fort. Die Runtime-Engine setzt die Ausführung des Tasks oder Containers fort.

(Geerbt von DtsContainer)
SaveToXML(XmlDocument, XmlNode, IDTSEvents)

Diese Methode kann durch den Anwendungscode nicht aufgerufen werden. Um ein Paket als XML-Datei zu speichern, verwenden Sie die SaveToXml(String, Package, IDTSEvents)-Methode.

(Geerbt von DtsContainer)
SetExpression(String, String)

Weist der Eigenschaft den angegebenen Ausdruck zu. Geben Sie null an, um einen vorhandenen Ausdruck aus der Eigenschaft zu entfernen.

SetWrappedExecutable(IDTSExecutable100)

Gibt das umschlossene ausführbare Objekt zurück.

(Geerbt von EventsProvider)
SuspendExecution()

Wird aufgerufen, wenn das ausführbare Element angehalten werden muss. Diese Methode wird von der Runtime-Engine aufgerufen.

(Geerbt von DtsContainer)
Validate(Connections, Variables, IDTSEvents, IDTSLogging)

Der Container kann feststellen, ob er ungültige Einstellungen enthält, die eine erfolgreiche Ausführung verhindern.

(Geerbt von DtsContainer)

Ereignisse

Disposed

Fügt einen Ereignishandler hinzu, der auf das Disposed-Ereignis für die Komponente lauscht.

(Geerbt von DtsContainer)

Gilt für: