Erreur (tâche)

  • Article

Arrête une génération et enregistre une erreur en fonction d’une instruction conditionnelle évaluée.

Paramètres

Le tableau ci-dessous décrit les paramètres de la tâche Error .

Paramètre Description
Code Paramètre String facultatif.

Code d’erreur à associer à l’erreur.
File Paramètre String facultatif.

Nom du fichier qui contient l’erreur. Si aucun nom de fichier n’est fourni, le fichier contenant la tâche Error est utilisé.
HelpKeyword Paramètre String facultatif.

Mot clé d’aide à associer à l’erreur. À usage interne uniquement.
HelpLink Paramètre String facultatif.

Lien vers plus d’informations sur l’erreur.
Text Paramètre String facultatif.

Texte d’erreur enregistré par MSBuild si le paramètre Condition a la valeur true.

Remarques

La tâche Error permet aux projets MSBuild d’émettre un texte d’erreur dans les enregistreurs d’événements et d’arrêter l’exécution de la génération.

Si le paramètre Condition a la valeur true, la génération est arrêtée, et une erreur est enregistrée. Si un paramètre Condition n’existe pas, l’erreur est enregistrée, et l’exécution de la génération s’arrête. Pour plus d’informations sur la journalisation, consultez Obtention de journaux de génération.

En plus des paramètres énumérés ci-dessus, cette tâche hérite des paramètres de la classe TaskExtension , qui elle-même hérite de la classe Task . Pour obtenir la liste de ces paramètres supplémentaires et leurs descriptions, consultez Classe de base TaskExtension.

HelpKeyword est utilisé par Visual Studio pour prendre en charge la fonctionnalité d’aide contextuelle (F1). Vous pouvez utiliser HelpLink pour associer une page d’aide en ligne à un message d’erreur.

Exemple

L’exemple de code suivant vérifie que toutes les propriétés requises sont définies. Si elles ne le sont pas, le projet déclenche un événement d’erreur et enregistre la valeur du paramètre Text de la tâche Error.

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <Target Name="ValidateCommandLine">
        <Error
            Text=" The 0 property must be set on the command line."
            Condition="'$(0)' == ''" />
        <Error
            Text="The FREEBUILD property must be set on the command line."
            Condition="'$(FREEBUILD)' == ''" />
    </Target>
    ...
</Project>

Voir aussi