Sdílet prostřednictvím

Error – úloha

  • Článek

Zastaví sestavení a zaprokoluje chybu na základě vyhodnoceného podmíněného příkazu.

Parametry

Následující tabulka popisuje parametry Error úlohy.

Parametr Popis
Code Volitelný String parametr.

Kód chyby, který se má přidružit k chybě.
File Volitelný String parametr.

Název souboru, který obsahuje chybu. Pokud není zadaný žádný název souboru, použije se soubor obsahující úlohu Chyba.
HelpKeyword Volitelný String parametr.

Klíčové slovo nápovědy pro přidružení k chybě Pouze pro vnitřní potřebu
HelpLink Volitelný String parametr.

Odkaz na další informace o chybě.
Text Volitelný String parametr.

Text chyby, který MSBuild protokoluje, pokud Condition se parametr vyhodnotí jako true.

Poznámky

Úloha Error umožňuje projektům MSBuild vydávat text chyby protokolovacím souborům a zastavit provádění sestavení.

Pokud se Condition parametr vyhodnotí jako true, sestavení se zastaví a zaprotokoluje se chyba. Condition Pokud parametr neexistuje, zaprotokoluje se chyba a spuštění sestavení se zastaví. Další informace o protokolování naleznete v tématu Získání protokolů sestavení.

Kromě výše uvedených parametrů tato úloha dědí parametry z TaskExtension třídy, která sama dědí z Task třídy. Seznam těchto dalších parametrů a jejich popisů naleznete v tématu TaskExtension základní třída.

HelpKeyword používá Visual Studio k podpoře funkce kontextové nápovědy (F1). Můžete použít HelpLink k přidružení online stránky nápovědy k chybové zprávě.

Příklad

Následující příklad kódu ověří, že jsou nastaveny všechny požadované vlastnosti. Pokud nejsou nastavené, projekt vyvolá chybovou událost a zaprokoluje hodnotu Text parametru Error úkolu.

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

Viz také