Warning タスク

  • [アーティクル]

条件付きステートメントの評価に基づいてビルド中の警告をログに記録します。

パラメーター

Warning タスクのパラメーターの説明を次の表に示します。

パラメーター 説明
Code 省略可能な String 型のパラメーターです。

警告に関連付ける警告コード。
File 省略可能な String 型のパラメーターです。

関連ファイルが存在する場合、それを指定します。 ファイルが指定されない場合、Warning タスクを含むファイルが使用されます。
HelpKeyword 省略可能な String 型のパラメーターです。

警告に関連付けるヘルプ キーワード。 内部でのみ使用します。
HelpLink 省略可能な String 型のパラメーターです。

警告に関する詳細へのリンク。
Text 省略可能な String 型のパラメーターです。

Condition パラメーターが true と評価された場合に MSBuild によってログに記録される警告テキストです。

解説

Warning タスクを使用すると、MSBuild プロジェクトにおいて、必要な構成やプロパティが存在していることを確認してから次のビルド手順に進むことができます。

Warning タスクの Condition パラメーターが true と評価される場合、Text パラメーターの値がログに記録され、ビルドが引き続き実行されます。 Condition パラメーターが存在しない場合は、警告テキストがログに記録されます。 ログ処理の詳細については、ビルド ログの取得に関するページを参照してください。

上記のパラメーター以外に、このタスクは TaskExtension クラスからパラメーターを継承します。このクラス自体は、Task クラスから継承されます。 これらの追加のパラメーターの一覧とその説明については、「TaskExtension Base Class」を参照してください。

HelpKeyword は、コンテキスト ヘルプVisual Studioをサポートするために、コンテキスト ヘルプ機能 (F1) によって使用されます。 HelpLink を使用して、オンライン ヘルプ ページをエラー メッセージに関連付けできます。

例

次のコード例では、コマンド ラインに設定されているプロパティが確認されます。 プロパティが設定されていない場合、警告イベントが生成され、Warning タスクの Text パラメーターの値がログに記録されます。

<Project xmlns="http://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>

関連項目