Error タスク

ビルドを停止し、条件付きステートメントの評価に基づいてエラーをログに記録します。

パラメーター

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

パラメーター	説明
Code	省略可能な String 型のパラメーターです。 エラーに関連付けるエラー コード。
File	省略可能な String 型のパラメーターです。 エラーが含まれているファイルの名前。 ファイル名が指定されていない場合は、Error タスクを含むファイルが使用されます。
HelpKeyword	省略可能な String 型のパラメーターです。 エラーに関連付けるヘルプ キーワード。 社外秘。
HelpLink	省略可能な String 型のパラメーターです。 エラーに関する詳細へのリンク。
Text	省略可能な String 型のパラメーターです。 Condition パラメーターが true と評価された場合に MSBuild によってログに記録されるエラー テキストです。

解説

Error タスクにより、MSBuild プロジェクトはロガーに対してエラー テキストを発行し、ビルドの実行を中断することができます。

Condition パラメーターが true と評価されると、ビルドを中止し、ログにエラーを記録します。 Condition パラメーターが存在しない場合には、エラーがログ記録され、ビルドの実行が中止されます。 ログ処理の詳細については、ビルド ログの取得に関するページを参照してください。

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

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

例

次のコード例では、すべての必須のプロパティが設定されていることを検証します。 該当するプロパティが設定されていない場合、Error タスクの Text パラメーターの値をログに記録します。

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

関連項目

• タスク リファレンス
• ビルド ログの取得