TaskHost Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Fournit un conteneur qui encapsule une tâche unique. Dans le concepteur SSIS, l’objet TaskHost n’est pas configuré séparément ; il est configuré lorsque vous définissez les propriétés de la tâche qu’il encapsule.
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
- Héritage
- Implémente
Exemples
L’exemple de code suivant montre la création d’un package vide. Deux tâches sont ajoutées au package et converties en classe TaskHost . TaskHost Les méthodes et les propriétés peuvent donc être utilisées sur l’une ou l’autre des tâches, telles que la InnerObject méthode, sans tenir compte du type de tâche qu’elle est.
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
Exemple de sortie :
Type Microsoft.SqlServer.Dts.Tasks.FileSystemTask.FileSystemTask
Type Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTask
Remarques
Integration Services fournit plusieurs types de conteneurs différents pour la génération de packages, avec l’un TaskHost de ces conteneurs. Le TaskHost conteneur fournit des services à une seule tâche. Il n’a pas d’élément correspondant dans la boîte à outils du concepteur graphique. L’objet TaskHost est un objet wrapper pour la tâche et est créé de manière transparente lors de la création de la tâche. Elle est retournée à partir de la Add méthode en tant qu’objet Executable et est castée en tant que TaskHost. Enfin, l’instance de tâche est accessible via la InnerObject propriété. Pour plus d’informations sur tous les conteneurs SSIS, consultez Conteneurs Integration Services.
Champs
m_executable |
Fichier exécutable. (Hérité de Executable) |
Propriétés
ApartmentThreaded |
Obtient une valeur qui indique si la tâche est un objet avec thread cloisonné. |
CreationName |
Retourne la chaîne utilisée pour créer une instance de l'objet DtsContainer. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
DebugMode |
Obtient ou définit une valeur booléenne qui indique si l’objet DtsContainer est en mode débogage et s’il doit déclencher l’événement lors de l’exécution OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) . (Hérité de DtsContainer) |
DelayValidation |
Obtient ou définit une valeur booléenne qui indique si la validation de la tâche est retardée jusqu’au moment de l’exécution. La valeur par défaut est false. (Hérité de DtsContainer) |
Description |
Obtient ou définit la description de l'objet DtsContainer. (Hérité de DtsContainer) |
Disable |
Valeur booléenne qui indique si l’objet DtsContainer est désactivé. (Hérité de DtsContainer) |
DisableEventHandlers |
Obtient ou définit une valeur booléenne qui indique si les gestionnaires d’événements sur la tâche sont désactivés. (Hérité de EventsProvider) |
EventHandlers |
Retourne une collection d'objets de gestionnaires d'événements. Ce champ est en lecture seule. (Hérité de EventsProvider) |
EventInfos |
Retourne une collection d'objets EventInfo. Ce champ est en lecture seule. (Hérité de EventsProvider) |
ExecutionDuration |
Retourne une valeur qui indique la durée d'exécution du conteneur en millisecondes. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
ExecutionResult |
Retourne une valeur qui indique la réussite ou l'échec de l'exécution de l'objet DtsContainer. (Hérité de DtsContainer) |
ExecutionStatus |
Retourne une valeur qui indique l'état actuel de l'exécution de l'objet DtsContainer au moment de l'appel. (Hérité de DtsContainer) |
ExecutionValue |
Obtient le résultat de l'exécution de la tâche. Cette propriété est en lecture seule. |
ExecValueVariable |
Obtient ou définit l'objet Variable personnalisé qui contient les résultats de l'exécution de la tâche. |
FailPackageOnFailure |
Obtient ou définit une valeur booléenne qui indique si le package échoue lorsqu’un conteneur enfant échoue. Cette propriété est utilisée sur les conteneurs, non sur le package lui-même. (Hérité de DtsContainer) |
FailParentOnFailure |
Obtient ou définit une valeur |
ForcedExecutionValue |
Si la propriété a la ForceExecutionValue valeur True, obtient ou définit une valeur qui spécifie la valeur d’exécution facultative retournée par le package. (Hérité de DtsContainer) |
ForceExecutionResult |
Obtient ou définit une valeur d'énumération DTSForcedExecResult qui spécifie le résultat d'exécution forcé du conteneur. (Hérité de DtsContainer) |
ForceExecutionValue |
Obtient ou définit une valeur booléenne qui indique si la valeur d’exécution du conteneur doit être forcée de contenir une valeur particulière. (Hérité de DtsContainer) |
HasExpressions |
Obtient une valeur qui indique si l'objet TaskHost possède des expressions. |
HostType |
Obtient une valeur de l'énumération DTSObjectHostType qui décrit l'hôte du conteneur. Cette propriété est en lecture seule. |
ID |
Retourne l'ID, qui est un GUID, de l'objet DtsContainer. Cette valeur est en lecture seule. (Hérité de DtsContainer) |
InnerObject |
Obtient la méthode utilisée pour accéder à l'instance de tâche hébergée par TaskHost. |
IsDefaultLocaleID |
Valeur booléenne qui indique si le conteneur utilise les paramètres régionaux par défaut. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
IsolationLevel |
Obtient ou définit le niveau d'isolation de la transaction dans l'objet DtsContainer. (Hérité de DtsContainer) |
LocaleID |
Obtient ou définit un entier qui indique l’ID de paramètres régionaux Microsoft Win32® à utiliser lors de l’exécution de l’objet DtsContainer . (Hérité de DtsContainer) |
LogEntryInfos |
Retourne un objet LogEntryInfos. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
LoggingMode |
Obtient ou définit une valeur valide à partir de l'énumération DTSLoggingMode qui indique le mode de journalisation du conteneur. (Hérité de DtsContainer) |
LoggingOptions |
Retourne un objet contenant des propriétés qui indiquent la ressource de filtrage et de journalisation des conteneurs. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
MaximumErrorCount |
Obtient ou définit une valeur Integer qui indique le nombre maximal d’erreurs pouvant se produire avant que l’objet DtsContainer cesse de s’exécuter. (Hérité de DtsContainer) |
Name |
Obtient ou définit le nom de l'objet DtsContainer. (Hérité de DtsContainer) |
Parent |
Retourne le conteneur parent. Cette valeur est en lecture seule. (Hérité de DtsContainer) |
Properties |
Obtient une collection DtsProperties qui contient les propriétés associées à la tâche. |
Site |
Obtient ou définit le site du conteneur. (Hérité de DtsContainer) |
StartTime |
Retourne l'heure à laquelle le conteneur a commencé l'exécution. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
StopTime |
Retourne l'heure à laquelle le conteneur a terminé l'exécution. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
SuspendRequired |
Obtient ou définit une valeur booléenne qui indique si les tâches doivent s’interrompre lorsqu’elles rencontrent un point d’arrêt. Cette valeur est définie par le moteur du runtime pour les tâches et les conteneurs lorsqu'un point d'arrêt est rencontré. (Hérité de DtsContainer) |
TransactionOption |
Obtient ou définit une valeur d'énumération DTSTransactionOption qui indique si le conteneur participe aux transactions. (Hérité de DtsContainer) |
VariableDispenser |
Retourne un objet VariableDispenser afin de pouvoir verrouiller les variables associées au conteneur. (Hérité de DtsContainer) |
Variables |
Retourne une collection qui contient les variables associées à ce conteneur. Cette propriété est en lecture seule. (Hérité de DtsContainer) |
Méthodes
AcceptBreakpointManager(BreakpointManager) |
Cette méthode est appelée par le moteur d'exécution lors de la création d'une tâche ou d'un conteneur, et lui transmet un gestionnaire BreakpointManager pour autoriser la tâche visant à créer, supprimer et vérifier l'état des points d'arrêt. Cette méthode est appelée par le runtime et n'est pas utilisée dans le code. (Hérité de DtsContainer) |
ComputeExpressions(Boolean) |
Calcule les expressions de l'objet TaskHost. |
Dispose() |
Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées. (Hérité de DtsContainer) |
Equals(Object) |
Détermine si les deux instances d'objet sont égales. (Hérité de DtsObject) |
Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) |
Exécute l'application, le conteneur ou le package dans le cadre d'un flux de travail de package. (Hérité de DtsContainer) |
GetExecutionPath() |
Retourne le chemin d'exécution du TaskHost actuel. |
GetExpression(String) |
Retourne l'expression pour la propriété spécifiée. Null signifie qu’aucune expression n’est affectée. |
GetHashCode() |
Retourne le code de hachage de cette instance. (Hérité de DtsObject) |
GetPackagePath() |
Retourne le chemin d'accès à l'emplacement de la tâche. |
LoadFromXML(XmlNode, IDTSEvents) |
Cette méthode ne peut pas être appelée par votre code d'application. Pour charger un package enregistré en tant que .xml, utilisez la méthode LoadPackage(String, IDTSEvents). (Hérité de DtsContainer) |
ResumeExecution() |
Reprend l'exécution de la tâche après une suspension. Le moteur du runtime reprend la tâche ou le conteneur. (Hérité de DtsContainer) |
SaveToXML(XmlDocument, XmlNode, IDTSEvents) |
Cette méthode ne peut pas être appelée par votre code d'application. Pour enregistrer un package en tant que .xml, utilisez la méthode SaveToXml(String, Package, IDTSEvents). (Hérité de DtsContainer) |
SetExpression(String, String) |
Affecte l'expression spécifiée à la propriété. Spécifiez null pour supprimer une expression existante de la propriété. |
SetWrappedExecutable(IDTSExecutable100) |
Retourne l'objet exécutable encapsulé. (Hérité de EventsProvider) |
SuspendExecution() |
Appelée lorsque l'exécutable doit s'interrompre. Cette méthode est appelée par le moteur du runtime. (Hérité de DtsContainer) |
Validate(Connections, Variables, IDTSEvents, IDTSLogging) |
Permet au conteneur de déterminer s'il contient des paramètres non valides qui l'empêcheront de s'exécuter correctement. (Hérité de DtsContainer) |
Événements
Disposed |
Ajoute un gestionnaire d'événements pour écouter l'événement Disposed sur le composant. (Hérité de DtsContainer) |