Skip to content

Latest commit

 

History

History
66 lines (53 loc) · 2.59 KB

error-task.md

File metadata and controls

66 lines (53 loc) · 2.59 KB
title ms.date ms.topic f1_keywords dev_langs helpviewer_keywords ms.assetid author ms.author manager ms.workload
Error Task | Microsoft Docs
11/04/2016
reference
VB
CSharp
C++
jsharp
Error task [MSBuild]
MSBuild, Error task
e96a90ee-a8ae-4e5b-8ef2-b5cf5fedd8b2
ghogen
ghogen
jillfra
multiple

Error task

Stops a build and logs an error based on an evaluated conditional statement.

Parameters

The following table describes the parameters of the Error task.

Parameter Description
Code Optional String parameter.

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

The name of the file that contains the error. If no file name is provided, the file containing the Error task will be used.
HelpKeyword Optional String parameter.

The Help keyword to associate with the error.
Text Optional String parameter.

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

Remarks

The Error task allows MSBuild projects to issue error text to loggers and stop build execution.

If the Condition parameter evaluates to true, the build is stopped, and an error is logged. If a Condition parameter does not exist, the error is logged and build execution stops. For more information on logging, see Obtaining 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.

Example

The following code example verifies that all required properties are set. 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>

See also