Skip to content

warning-task.md

Latest commit

 

History

History
67 lines (52 loc) · 3 KB

warning-task.md

File metadata and controls

67 lines (52 loc) · 3 KB
title Warning Task
description Learn how MSBuild uses the Warning task to log a warning during a build based on an evaluated conditional statement.
ms.date 11/04/2016
ms.topic reference
f1_keywords
dev_langs
VB
CSharp
C++
helpviewer_keywords
Warning task [MSBuild]
MSBuild, Warning task
author ghogen
ms.author ghogen
ms.subservice msbuild

Warning task

Logs a warning during a build based on an evaluated conditional statement.

Parameters

The following table describes the parameters of the Warning task.

Parameter Description
Code Optional String parameter.

The warning code to associate with the warning.
File Optional String parameter.

Specifies the relevant file, if any. If no file is provided, the file containing the Warning task is used.
HelpKeyword Optional String parameter.

The Help keyword to associate with the warning. For internal use only.
HelpLink Optional String parameter.

A link to more information about the warning.
Text Optional String parameter.

The warning text that MSBuild logs if the Condition parameter evaluates to true.

Remarks

The Warning task allows MSBuild projects to check for the presence of a required configuration or property before proceeding with the next build step.

If the Condition parameter of the Warning task evaluates to true, the value of the Text parameter is logged and the build continues to execute. If a Condition parameter does not exist, the warning text is logged. For more information on logging, see Obtain build logs.

In addition to the parameters listed above, this task inherits parameters from the xref:Microsoft.Build.Tasks.TaskExtension class, which itself inherits from the xref:Microsoft.Build.Utilities.Task class. For a list of these additional parameters and their descriptions, see TaskExtension base class.

HelpKeyword is used by Visual Studio to support the contextual help feature (F1). You can use HelpLink to associate an online help page with an error message.

Example

The following code example checks for properties that are set on the command line. If there are no properties set, the project raises a warning event, and logs the value of the Text parameter of the Warning task.

<Project>
    <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>

See also