tarefa Error

  • Artigo

Interrompe um build e registra um erro com base em uma instrução condicional avaliada.

Parâmetros

A tabela a seguir descreve os parâmetros da tarefa Error.

Parâmetro Descrição
Code Parâmetro String opcional.

O código de erro a associar ao erro.
File Parâmetro String opcional.

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 Parâmetro String opcional.

A palavra-chave de ajuda a ser associada ao erro. Apenas para uso interno.
HelpLink Parâmetro String opcional.

Um link para obter mais informações sobre o erro.
Text Parâmetro String opcional.

O texto do erro que o MSBuild registra se o parâmetro Condition resulta em true.

Comentários

A tarefa Error permite que os projetos do MSBuild emitam o texto de erro para os agentes e interrompam a execução do build.

Se o parâmetro Condition avaliar true, o build será interrompido e um erro será registrado. Se um parâmetro Condition não existir, o erro será registrado e a execução de build será interrompida. Para obter mais informações sobre o log, confira Obtendo logs de build.

Além dos parâmetros listados acima, essa tarefa herda parâmetros da classe TaskExtension, que herda da classe Task. Para obter uma lista desses parâmetros adicionais e suas descrições, confira Classe base TaskExtension.

HelpKeyword é usado pelo Visual Studio para dar suporte ao recurso de ajuda contextual (F1). Você pode usar HelpLink para associar uma página de ajuda online a uma mensagem de erro.

Exemplo

O exemplo de código a seguir verifica se todas as propriedades necessárias estão definidas. Se elas não estiverem definidas, o projeto gerará um evento de erro e registrará o valor do parâmetro Text da tarefa 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>

Confira também