Error (tarea)

  • Artículo

Detiene una compilación y registra un error basándose en una instrucción condicional evaluada.

Parámetros

En la siguiente tabla se describen los parámetros de la tarea Error .

Parámetro Descripción
Code Parámetro String opcional.

Código de error que se debe asociar con el error.
File Parámetro String opcional.

El nombre del archivo que contiene el error. Si no se proporciona ningún nombre de archivo, se utilizará el archivo que contiene la tarea Error.
HelpKeyword Parámetro String opcional.

Palabra clave de ayuda que se debe asociar con el error. Solo para uso interno.
HelpLink Parámetro String opcional.

Un vínculo para obtener más información sobre el error.
Text Parámetro String opcional.

Texto de error que registra MSBuild si el parámetro Condition se evalúa como true.

Observaciones

La tarea Error permite que los proyectos de MSBuild emitan el texto de error a los registradores y detengan la ejecución de la compilación.

Si el parámetro Condition se evalúa como true, la compilación se detiene y se registra un error. Si no existe ningún parámetro Condition, el error se registra y se detiene la ejecución de la compilación. Para obtener más información sobre los registros, vea Obtener registros de compilación con MSBuild.

Además de los parámetros mencionados anteriormente, esta tarea hereda los parámetros de la clase TaskExtension, que a su vez hereda de la clase Task. Para obtener una lista de estos parámetros adicionales y sus descripciones, consulte TaskExtension base class.

Visual Studio utiliza HelpKeyword para admitir la característica de ayuda contextual (F1). Puede usar HelpLink para asociar una página de ayuda en línea con un mensaje de error.

Ejemplo

En el ejemplo de código siguiente se comprueba que se hayan establecido todas las propiedades necesarias. Si no están establecidas, el proyecto genera un evento de error y registra el valor del parámetro Text de la tarea 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>

Vea también