Задача Error
Останавливает построение и регистрирует ошибку в журнале событий на основании вычисленного условного оператора.
Параметры
В следующей таблице описаны параметры задачи Error.
Параметр |
Описание |
|---|---|
Code |
Необязательный параметр типа String. Код, связанный с данной ошибкой. |
File |
Необязательный параметр типа String. Имя файла, содержащего ошибку. Если файл не предоставлен, используется файл, содержащий задачу Error. |
HelpKeyword |
Необязательный параметр типа String. Ключевое слово справки, сопоставляемое с ошибкой. |
Text |
Необязательный параметр типа String. Текст ошибки, регистрируемый в журнале MSBuild в случае, если результат вычисления параметра Condition оказывается равным true. |
Заметки
Задача Error позволяет передавать текст ошибок в средства ведения журнала и останавливать выполнение построения в проектах MSBuild.
Если результат вычисления параметра Condition оказывается равным true, построение останавливается, и ошибка регистрируется в журнале. Если параметр Condition не существует, ошибка регистрируется в журнале, и выполнение построения останавливается. Дополнительные сведения о ведении журнала см. в разделе Получение журналов построения с помощью MSBuild.
Помимо параметров, которые перечислены выше, эта задача наследует параметры от класса TaskExtension, который наследует от класса Task. Чтобы получить список этих доп параметров и их описаний, см. Базовый класс TaskExtension.
Пример
В следующем примере кода проверяется, что установлены все обязательные свойства. Если это не так, проект инициирует событие ошибки и регистрирует в журнале значение параметра Text задачи Error.
<Project xmlns="https://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>
См. также
Основные понятия
Получение журналов построения с помощью MSBuild