Avertissement (tâche)

  • Article

Enregistre un avertissement durant une génération en fonction d’une instruction conditionnelle évaluée.

Paramètres

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

Paramètre Description
Code Paramètre String facultatif.

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

Spécifie le fichier approprié, le cas échéant. Si aucun fichier n’est fourni, le fichier qui contient la tâche d’avertissement (Warning) est utilisé.
HelpKeyword Paramètre String facultatif.

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

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

Texte d’avertissement que MSBuild journalise si le paramètre Condition a la valeur true.

Notes

La tâche Warning permet aux projets MSBuild de vérifier la présence d’une configuration requise ou d’une propriété obligatoire avant de passer à l’étape de génération suivante.

Si le paramètre Condition de la tâche Warning a la valeur true, la valeur du paramètre Text est journalisée et la génération se poursuit. Si aucun paramètre Condition n’existe, le texte de l’avertissement est journalisé. Pour plus d’informations sur la journalisation, voir Obtenir des 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 les propriétés définies sur la ligne de commande. Si aucune propriété n’est définie, le projet déclenche un événement d’avertissement et journalise la valeur du paramètre Text de la tâche Warning.

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

Voir aussi