Error タスク
更新 : 2007 年 11 月
条件付きステートメントの評価に基づいてビルドを停止し、エラーをログに記録します。
パラメータ
Error タスクのパラメータの説明を次の表に示します。
パラメータ |
説明 |
|---|---|
Code |
省略可能な String 型のパラメータです。 エラーに関連付けられたエラー コードです。 |
HelpKeyword |
省略可能な String 型のパラメータです。 エラーに関連付けられたヘルプ キーワードです。 |
Text |
省略可能な String 型のパラメータです。 Condition パラメータが true と評価された場合に、MSBuild がログに記録するエラー テキストです。 |
解説
Error タスクは、MSBuild プロジェクトでロガーに対してメッセージ テキストを発行し、ビルドの実行を中断します。
Condition パラメータが true と評価されると、ビルドを中止し、ログにエラーを記録します。Condition パラメータが存在しない場合には、その場でエラーを記録し、ビルドを中止します。ログ処理の詳細については、「MSBuild でのログの概要」を参照してください。
使用例
次のコード例は、必ず指定する必要があるすべてのプロパティが設定されていることを検証します。プロパティが設定されていない場合、プロジェクトではエラー イベントを発生し、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>