Error タスク
条件付きステートメントの評価に基づいてビルドを停止し、エラーをログに記録します。
パラメーター
Error タスクのパラメーターの説明を次の表に示します。
パラメーター |
Description |
|---|---|
Code |
省略可能な String 型のパラメーターです。 エラーに関連付けるエラー コードです。 |
File |
省略可能な String 型のパラメーターです。 エラーを格納するファイルの名前です。 ファイル名を指定しなかった場合は、Error タスクを含むファイルが使用されます。 |
HelpKeyword |
省略可能な String 型のパラメーターです。 エラーに関連付けるヘルプ キーワードです。 |
Text |
省略可能な String 型のパラメーターです。 Condition パラメーターが true と評価された場合に、MSBuild がログに記録するエラー テキストです。 |
解説
Error タスクは、MSBuild プロジェクトでロガーに対してメッセージ テキストを発行し、ビルドの実行を中断します。
Condition パラメーターが true と評価されると、ビルドを中止し、ログにエラーを記録します。 Condition パラメーターが存在しない場合には、その場でエラーを記録し、ビルドを中止します。 ログ処理の詳細については、「MSBuild でのビルド ログの取得」を参照してください。
上記のパラメーター以外に、このタスクは TaskExtension クラスからパラメーターを継承します。このクラス自体は、Task クラスから継承されます。 これらの追加のパラメーターの一覧とその説明については、「TaskExtension 基本クラス」を参照してください。
使用例
次のコード例は、必ず指定する必要があるすべてのプロパティが設定されていることを検証します。 プロパティが設定されていない場合、プロジェクトではエラー イベントを発生し、Error タスクの Text パラメーターの値をログに記録します。
<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>