Error, tâche
Arrête une génération et enregistre une erreur basée sur une instruction conditionnelle évaluée.
Paramètres
Le tableau suivant 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 qui contient la tâche d'erreur (Error) sera utilisé. |
HelpKeyword |
Paramètre String facultatif. Mot clé d'aide à associer à l'erreur. |
Text |
Paramètre String facultatif. Texte d'erreur enregistré par MSBuild si le paramètre Condition prend la valeur true. |
Notes
La tâche Error permet aux projets MSBuild d'envoyer le texte d'erreur aux 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 s'arrête et une erreur est enregistrée. S'il n'existe pas de paramètre Condition, l'erreur est enregistrée et arrête l'exécution de la génération. Pour plus d'informations sur la journalisation, consultez Obtention de journaux de génération avec MSBuild.
En plus des paramètres énumérés ci-dessus, cette tâche hérite des paramètres de la classe TaskExtension, qui hérite elle-même de la classe Task. Pour obtenir la liste de ces paramètres supplémentaires et de leurs descriptions, consultez Classe TaskExtension Base.
Exemple
L'exemple de code suivant vérifie que toutes les propriétés requises sont définies. Si ce n'est pas le cas, le projet génère un événement d'erreur et enregistre la valeur du paramètre Text de la tâche Error dans un journal.
<Project xmlns="https://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
Concepts
Obtention de journaux de génération avec MSBuild