Fehleraufgabe

  • Artikel

Beendet einen Build, und protokolliert einen Fehler basierend auf einer ausgewerteten Bedingungsanweisung.

Parameter

In der folgenden Tabelle werden die Parameter der Error -Aufgabe beschrieben.

Parameter Beschreibung
Code Optionaler String-Parameter.

Der dem Fehler zuzuordnende Fehlercode.
File Optionaler String-Parameter.

Der Name der Datei, die den Fehler enthält. Wenn kein Dateiname angegeben wird, wird die Datei verwendet, die die Error-Aufgabe enthält.
HelpKeyword Optionaler String-Parameter.

Das dem Fehler zuzuordnende Hilfeschlüsselwort. Nur zur internen Verwendung.
HelpLink Optionaler String-Parameter.

Ein Link zu weiteren Informationen zum Fehler
Text Optionaler String-Parameter.

Der Fehlertext, den MSBuild protokolliert, wenn der Condition-Parameter als true ausgewertet wird.

Hinweise

Die Error-Aufgabe ermöglicht es, das MSBuild-Projekte Fehlertext an Protokollierungen ausgeben und die Buildausführung beenden.

Wenn der Condition-Parameter true entspricht wird der Build beendet und ein Fehler protokolliert. Wenn kein Condition-Parameter vorhanden ist, wird der Fehler Protokolliert und die Buildausführung wird beendet. Weitere Informationen zur Protokollierung finden Sie unter Erhalten von Buildprotokollen.

Zusätzlich zu den oben aufgeführten Parametern erbt diese Aufgabe Parameter von der TaskExtension-Klasse, die selbst von der Task-Klasse erbt. Eine Liste mit diesen zusätzlichen Parametern und ihren Beschreibungen finden Sie unter TaskExtension-Basisklasse.

HelpKeyword wird von Visual Studio verwendet, um das Kontexthilfefeature (F1) zu unterstützen. Sie können HelpLink verwenden, um eine Onlinehilfeseite einer Fehlermeldung zuzuordnen.

Beispiel

Im folgenden Codebeispiel wird überprüft, ob alle erforderlichen Eigenschaften festgelegt sind. Wenn sie nicht festgelegt sind, löst das Projekt ein Fehlerereignis aus, und protokolliert den Wert des Text-Parameters der Error-Aufgabe.

<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>

Weitere Informationen