Tarefa Error
Pára um build e registra o erro baseado em uma instrução condicional avaliada.
Parâmetros
A tabela a seguir descreve os parâmetros da Error tarefa.
Parâmetro |
Descrição |
---|---|
Code |
Opcional String parâmetro. O código de erro para associar o erro. |
File |
Opcional String parâmetro. O nome do arquivo que contém o erro. Se nenhum nome de arquivo for fornecido, o arquivo que contém a tarefa de erro será usado. |
HelpKeyword |
Opcional String parâmetro. A Ajuda palavra-chave para associar o erro. |
Text |
Opcional String parâmetro. O texto de erro que MSBuild registra se o Condition parâmetro resultar em true. |
Comentários
O Error tarefa permite que MSBuild emitir o texto de erro para registradores de projetos e parar a execução de compilação.
Se a Condition parâmetro resultar em true, a compilação é interrompida e um erro será registrado. Se um Condition parâmetro não existir, o erro é registrado e construir a execução pára. Para obter mais informações sobre o registro em log, consulte Obtendo logs de compilação com o MSBuild.
Com os parâmetros listados acima, esta tarefa herda os parâmetros da TaskExtension herda de classe, que por si só a Task classe. Para obter uma lista desses parâmetros adicionais e suas descrições, consulte Classe TaskExtension (base).
Exemplo
O exemplo de código a seguir verifica se todas as necessárias propriedades são definidas. Se elas não estiverem definidas, o projeto gera um evento de erro e registra o valor da Text parâmetro da Error tarefa.
<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>
Consulte também
Conceitos
Obtendo logs de compilação com o MSBuild