Error, tâcheError Task

Arrête une génération et enregistre une erreur en fonction d’une instruction conditionnelle évaluée.Stops a build and logs an error based on an evaluated conditional statement.

ParamètresParameters

Le tableau ci-dessous décrit les paramètres de la tâche Error.The folowing table describes the parameters of the Error task.

ParamètreParameter DescriptionDescription
Code Paramètre String facultatif.Optional String parameter.

Code d’erreur à associer à l’erreur.The error code to associate with the error.
File Paramètre String facultatif.Optional String parameter.

Nom du fichier qui contient l’erreur.The name of the file that contains the error. Si aucun nom de fichier n’est fourni, le fichier contenant la tâche Error est utilisé.If no file name is provided, the file containing the Error task will be used.
HelpKeyword Paramètre String facultatif.Optional String parameter.

Mot clé d’aide à associer à l’erreur.The Help keyword to associate with the error.
Text Paramètre String facultatif.Optional String parameter.

Texte d’erreur enregistré par MSBuildMSBuild si le paramètre Condition a la valeur true.The error text that MSBuildMSBuild logs if the Condition parameter evaluates to true.

NotesRemarks

La tâche Error permet aux projets MSBuildMSBuild d’émettre un texte d’erreur dans les enregistreurs d’événements et d’arrêter l’exécution de la génération.The Error task allows MSBuildMSBuild projects issue error text to loggers and stop build execution.

Si le paramètre Condition a la valeur true, la génération est arrêtée, et une erreur est enregistrée.If the Condition parameter evaluates to true, the build is stopped, and an error is logged. 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.If a Condition parameter does not exist, the error is logged and build execution stops. Pour plus d’informations sur la journalisation, consultez l’article Obtention de journaux de génération avec MSBuild.For more information on logging, see Obtaining Build Logs.

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.In addition to the parameters listed above, this task inherits parameters from the TaskExtension class, which itself inherits from the Task class. Pour obtenir la liste de ces paramètres supplémentaires et leurs descriptions, consultez TaskExtension Base Class.For a list of these additional parameters and their descriptions, see TaskExtension Base Class.

ExempleExample

L’exemple de code suivant vérifie que toutes les propriétés requises sont définies.The following code example verifies that all required properties are set. 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.If they are not set, the project raises an error event, and logs the value of the Text parameter of the Error task.

<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 aussiSee Also

Référence des tâches Task Reference
Obtention de journaux de génération avec MSBuildObtaining Build Logs