Error Task

 

For the latest documentation on Visual Studio 2017, see Visual Studio 2017 Documentation.

For the latest documentation on Visual Studio 2017, see Error Task on docs.microsoft.com. Stops a build and logs an error based on an evaluated conditional statement.

The folowing table describes the parameters of the Error task.

ParameterDescription
CodeOptional String parameter.

The error code to associate with the error.
FileOptional 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.
HelpKeywordOptional String parameter.

The Help keyword to associate with the error.
TextOptional String parameter.

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

The Error task allows MSBuild projects 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 TaskExtension class, which itself inherits from the Task class. For a list of these additional parameters and their descriptions, see TaskExtension Base Class.

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>  

Task Reference
Obtaining Build Logs

Show: