Error-Aufgabe
Hält einen Build an und protokolliert einen Fehler anhand 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 keine Datei angegeben ist, wird die Datei mit der Error-Aufgabe verwendet. |
HelpKeyword |
Optionaler String-Parameter. Das dem Fehler zuzuordnende Hilfeschlüsselwort. |
Text |
Optionaler String-Parameter. Der Fehlertext, den MSBuild protokolliert, wenn der Condition-Parameter true ergibt. |
Hinweise
Mithilfe der Error-Aufgabe können MSBuild-Projekte Fehlertext an Protokollierungen ausgeben und die Buildausführung anhalten.
Wenn der Condition-Parameter true ergibt, wird die Buildausführung angehalten und ein Fehler protokolliert. Wenn kein Condition-Parameter vorhanden ist, wird der Fehler protokolliert und die Buildausführung angehalten. Weitere Informationen zur Protokollierung finden Sie unter Erhalten von Buildprotokollen mit MSBuild.
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.
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="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>
Siehe auch
Konzepte
Erhalten von Buildprotokollen mit MSBuild