Error — Zadanie
Zatrzymuje kompilację i rejestruje błąd na podstawie ocenianej instrukcji warunkowej.
Parametry
W poniższej tabeli opisano parametry Error zadania.
| Parametr | Opis |
|---|---|
Code |
Opcjonalny String parametr.Kod błędu do skojarzenia z błędem. |
File |
Opcjonalny String parametr.Nazwa pliku zawierającego błąd. Jeśli nie podano nazwy pliku, zostanie użyty plik zawierający zadanie Błąd. |
HelpKeyword |
Opcjonalny String parametr.Słowo kluczowe pomocy do skojarzenia z błędem. Tylko do użytku wewnętrznego. |
HelpLink |
Opcjonalny String parametr.Link do dodatkowych informacji o błędzie. |
Text |
Opcjonalny String parametr.Tekst błędu, który program MSBuild rejestruje, jeśli Condition parametr zwróci wartość true. |
Uwagi
Zadanie Error umożliwia projektom MSBuild wystawianie tekstu błędu w loggerach i zatrzymywanie wykonywania kompilacji.
Condition Jeśli parametr zwróci wartość true, kompilacja zostanie zatrzymana i zostanie zarejestrowany błąd. Condition Jeśli parametr nie istnieje, zostanie zarejestrowany błąd i wykonanie kompilacji zostanie zatrzymane. Aby uzyskać więcej informacji na temat rejestrowania, zobacz Uzyskiwanie dzienników kompilacji.
Oprócz parametrów wymienionych powyżej to zadanie dziedziczy parametry z TaskExtension klasy, która sama dziedziczy z Task klasy. Aby uzyskać listę tych dodatkowych parametrów i ich opisy, zobacz TaskExtension, klasa bazowa.
HelpKeyword jest używany przez program Visual Studio do obsługi funkcji pomocy kontekstowej (F1). Możesz użyć HelpLink polecenia , aby skojarzyć stronę pomocy online z komunikatem o błędzie.
Przykład
Poniższy przykład kodu sprawdza, czy wszystkie wymagane właściwości są ustawione. Jeśli nie są ustawione, projekt zgłasza zdarzenie błędu i rejestruje wartość Text parametru Error zadania.
<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>