Error 任务

  • 项目

基于评估的条件语句，停止生成操作并记录错误。

参数

下表描述了 Error 任务的参数。

参数 说明
Code 可选 String 参数。

与错误关联的错误代码。
File 可选 String 参数。

包含错误的文件的名称。 如果未提供任何文件名称，将使用包含 Error 任务的文件。
HelpKeyword 可选 String 参数。

与错误关联的帮助关键字。 仅供内部使用。
HelpLink 可选 String 参数。

错误详细信息的链接。
Text 可选 String 参数。

如果 Condition 参数计算结果为 true，则为 MSBuild 记录的错误文本。

注解

Error 任务允许 MSBuild 项目将错误文本上报给记录器并停止执行生成。

如果 Condition 参数评估为 true，将停止生成，并记录一个错误。 如果 Condition 参数不存在，将记录错误并停止执行生成。 有关日志记录的详细信息，请参阅获取生成日志。

除上面列出的参数外，此任务还从 TaskExtension 类继承参数，后者自身继承自 Task 类。 有关这些其他参数的列表及其说明的信息，请参阅 TaskExtension 基类。

Visual Studio 使用 HelpKeyword 来支持上下文帮助功能 (F1)。 可使用 HelpLink 将联机帮助页与错误消息相关联。

示例

以下代码示例验证所有所需的属性均得以设置。 如果未设置这些属性，则项目引发错误事件，并记录 Error 任务中 Text 参数的值。

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

另请参阅