Error (Tarea)
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 va a asociar al error. |
File |
Parámetro String opcional. El nombre del archivo que contiene el error. Si no se proporciona ningún nombre de archivo, se usará el archivo que contiene la tarea Error. |
HelpKeyword |
Parámetro String opcional. Palabra clave de Ayuda que se va a asociar al error. |
Text |
Parámetro String opcional. Texto de error que MSBuild registra si el parámetro Condition se evalúa como true. |
Comentarios
La tarea Error permite que los proyectos de MSBuild envíen un 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, se detiene la compilación y se registra un error. Si no existe un parámetro Condition, se registra el error y se detiene la ejecución de la compilación. Para obtener más información sobre el registro, vea Información general sobre registro en MSBuild.
Además de los parámetros mencionados anteriormente, esta tarea hereda los parámetros de la clase TaskExtension, que hereda de la clase Task. Para obtener una lista de estos parámetros adicionales y sus descripciones, vea TaskExtension (Clase base).
Ejemplo
En el ejemplo de código siguiente se comprueba que se han establecido todas las propiedades necesarias. Si no están establecidas, el proyecto produce un evento de error y registra el valor del parámetro Text de la tarea 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>
Vea también
Conceptos
Información general sobre registro en MSBuild