Partager via


Classe de base ToolTaskExtension

De nombreuses tâches héritent de la classe ToolTaskExtension, qui hérite de la classe ToolTask, qui hérite elle-même de la classe Task.Cette chaîne d'héritage ajoute plusieurs paramètres aux tâches qui en dérivent.Ces paramètres sont énumérés dans le présent document.

Paramètres

Le tableau suivant décrit les paramètres des classes de base.

Paramètre

Description

BuildEngine

Paramètre IBuildEngine facultatif.

Spécifie l'interface du moteur de génération disponible pour les tâches.Le moteur de génération définit automatiquement ce paramètre de manière à ce qu'il autorise les tâches à y effectuer des rappels.

BuildEngine2

Paramètre IBuildEngine2 facultatif.

Spécifie l'interface du moteur de génération disponible pour les tâches.Le moteur de génération définit automatiquement ce paramètre de manière à ce qu'il autorise les tâches à y effectuer des rappels.

Il s'agit d'une propriété de commodité qui évite aux auteurs de la tâche héritant de cette classe d'avoir à effectuer un cast de la valeur de IBuildEngine en IBuildEngine2.

BuildEngine3

Paramètre IBuildEngine3 facultatif.

Spécifie l'interface du moteur de génération fournie par l'hôte.

EchoOff

Paramètre bool facultatif.

Lorsque la valeur est true, cette tâche passe /Q à la ligne de commande cmd.exe pour que la ligne de commande ne soit pas copiée dans stdout.

EnvironmentVariables

Paramètre de tableau String facultatif.

Tableau de paires de variables d'environnement, séparées par un signe égal.Ces variables sont passées au fichier exécutable généré et viennent s'ajouter (ou se substituer de manière sélective) au bloc environnement normal.

ExitCode

Paramètre de sortie en lecture seule Int32 facultatif.

Spécifie le code de sortie fourni par la commande exécutée.Si la tâche a journalisé toutes les erreurs, mais que le processus avait un code de sortie de 0 (succès), la valeur définie est -1.

HostObject

Paramètre ITaskHost facultatif.

Spécifie l'instance d'objet hôte (peut être null).Le moteur de génération définit cette propriété si l'IDE hôte a associé un objet hôte à cette tâche particulière.

Log

Paramètre en lecture seule TaskLoggingHelper facultatif.

Obtient une instance d'une classe TaskLoggingHelperExtension contenant des méthodes d'enregistrement des tâches.

LogStandardErrorAsError

Paramètre d'option bool.

Si la valeur est true, tous les messages reçus sur le flux d'erreur standard sont enregistrés en tant qu'erreurs.

StandardErrorImportance

Paramètre String facultatif.

Importance avec laquelle le texte doit être enregistré à partir du flux de sortie standard.

StandardOutputImportance

Paramètre String facultatif.

Importance avec laquelle le texte doit être enregistré à partir du flux de sortie standard.

Timeout

Paramètre Int32 facultatif virtuel.

Spécifie la durée, en millisecondes, après laquelle la tâche exécutable est terminée.La valeur par défaut est Int.MaxValue, indiquant qu'il n'existe aucun délai d'attente. La valeur du délai d'attente est exprimée en millisecondes.

ToolExe

Paramètre string facultatif virtuel.

Les projets peuvent l'implémenter pour substituer un ToolName.Les tâches peuvent substituer ceci afin de préserver ToolName.

ToolPath

Paramètre string facultatif.

Spécifie l'emplacement à partir duquel la tâche charge le fichier exécutable sous-jacent.Si ce paramètre n'est pas spécifié, la tâche utilise le chemin d'accès d'installation du Kit de développement logiciel qui correspond à la version de l'infrastructure exécutant MSBuild.

UseCommandProcessor

Paramètre bool facultatif.

Lorsque la valeur est true, cette tâche crée un fichier de commandes pour la ligne de commande et l'exécute à l'aide du processeur de commandes au lieu d'exécuter la commande directement.

YieldDuringToolExecution

Paramètre bool facultatif.

Lorsque la valeur est true, cette tâche donne le nœud lorsque sa tâche s'exécute.

Voir aussi

Concepts

Tâches MSBuild

Autres ressources

Référence des tâches MSBuild