Warning タスク
条件付きステートメントの評価に基づいてビルド中の警告をログに記録します。
パラメーター
Warning タスクのパラメーターの説明を次の表に示します。
パラメーター |
Description |
---|---|
Code |
省略可能な String 型のパラメーターです。 警告に関連付けられた警告コードです。 |
File |
省略可能な String 型のパラメーターです。 関連ファイルを指定します (存在する場合)。ファイルを指定しなかった場合は、Warning タスクを含むファイルが使用されます。 |
HelpKeyword |
省略可能な String 型のパラメーターです。 警告に関連付けるヘルプ キーワードです。 |
Text |
省略可能な String 型のパラメーターです。 Condition パラメーターが true と評価された場合に、MSBuild がログに記録する警告テキストです。 |
解説
Warning タスクを使用すると、MSBuild プロジェクトで、次のビルド ステップに進む前に、必要な構成やプロパティがあるかどうかをチェックできます。
Warning タスクの Condition パラメーターが true と評価された場合、このタスクの Text パラメーターの値がログに記録され、ビルド処理が継続されます。Condition パラメーターを指定しない場合は、警告テキストがログに記録されます。ログ処理の詳細については、「MSBuild でのビルド ログの取得」を参照してください。
上記のパラメーター以外に、このタスクは TaskExtension クラスからパラメーターを継承します。このクラス自体は、Task クラスから継承されます。これらの追加のパラメーターの一覧とその説明については、「TaskExtension 基本クラス」を参照してください。
使用例
次のコード例では、コマンド ラインで設定されるプロパティが設定されているかどうかをチェックします。プロパティが設定されていない場合、プロジェクトでは警告イベントを発生し、Warning タスクの Text パラメーターの値がログに記録されます。
<Project xmlns="https://schemas.microsoft.com/developer/msbuild/2003">
<Target Name="ValidateCommandLine">
<Warning
Text=" The 0 property was not set on the command line."
Condition="'$(0)' == ''" />
<Warning
Text=" The FREEBUILD property was not set on the command line."
Condition="'$(FREEBUILD)' == ''" />
</Target>
...
</Project>