Error - задача

  • Статья

Останавливает сборку и регистрирует ошибку в журнале событий на основании вычисленного условного оператора.

Параметры

В следующей таблице приводятся параметры задачи Error.

Параметр Описание
Code Необязательный параметр String.

Код ошибки для связи с ошибкой.
File Необязательный параметр String.

Имя файла, содержащего ошибку. Если имя файла не указано, используется файл, содержащий задачу Error.
HelpKeyword Необязательный параметр String.

Ключевое слово справки для связи с ошибкой. Только для внутреннего пользования.
HelpLink Необязательный параметр String.

Ссылка на дополнительные сведения об ошибке.
Text Необязательный параметр String.

Текст ошибки, регистрируемый в журнале MSBuild, если результат вычисления параметра Condition оказывается равным true.

Замечания

Задача Error позволяет передавать текст ошибок в средства ведения журнала и останавливать выполнение сборки в проектах MSBuild.

Если результат вычисления параметра Condition оказывается равным true, сборка останавливается, а ошибка регистрируется в журнале. Если параметр Condition не существует, ошибка регистрируется в журнале, а выполнение сборки останавливается. Дополнительные сведения о ведении журнала см. в разделе Получение журналов сборки.

Помимо перечисленных выше параметров, эта задача наследует параметры от класса TaskExtension, который, в свою очередь, наследует от класса Task. Список этих дополнительных параметров и их описания см. в статье Базовый класс TaskExtension.

HelpKeyword используется Visual Studio для поддержки функции контекстной справки (F1). С помощью HelpLink можно связать страницу справки в Интернете с сообщением об ошибке.

Пример

В следующем примере кода проверяется, что установлены все обязательные свойства. Если это не так, проект инициирует событие ошибки и регистрирует в журнале значение параметра Text задачи Error.

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

См. также