Error タスクError Task

ビルドを停止し、条件付きステートメントの評価に基づいてエラーをログに記録します。Stops a build and logs an error based on an evaluated conditional statement.

パラメーターParameters

Error タスクのパラメーターの説明を次の表に示します。The folowing table describes the parameters of the Error task.

パラメーターParameter 説明Description
Code 省略可能な String 型のパラメーターです。Optional String parameter.

エラーに関連付けるエラー コード。The error code to associate with the error.
File 省略可能な String 型のパラメーターです。Optional String parameter.

エラーが含まれているファイルの名前。The name of the file that contains the error. ファイル名が指定されていない場合は、Error タスクを含むファイルが使用されます。If no file name is provided, the file containing the Error task will be used.
HelpKeyword 省略可能な String 型のパラメーターです。Optional String parameter.

エラーに関連付けるヘルプ キーワード。The Help keyword to associate with the error.
Text 省略可能な String 型のパラメーターです。Optional String parameter.

Condition パラメーターが true と評価された場合に、MSBuildMSBuild がログに記録するエラー テキストです。The error text that MSBuildMSBuild logs if the Condition parameter evaluates to true.

コメントRemarks

Error タスクで、MSBuildMSBuild プロジェクトはロガーに対してメッセージ テキストを発行し、ビルドの実行を中断します。The Error task allows MSBuildMSBuild projects issue error text to loggers and stop build execution.

Condition パラメーターが true と評価されると、ビルドを中止し、ログにエラーを記録します。If the Condition parameter evaluates to true, the build is stopped, and an error is logged. Condition パラメーターが存在しない場合には、エラーがログ記録され、ビルドの実行が中止されます。If a Condition parameter does not exist, the error is logged and build execution stops. ログ処理の詳細については、ビルド ログの取得に関するページを参照してください。For more information on logging, see Obtaining Build Logs.

上記のパラメーター以外に、このタスクは TaskExtension クラスからパラメーターを継承します。このクラス自体は、Task クラスから継承されます。In addition to the parameters listed above, this task inherits parameters from the TaskExtension class, which itself inherits from the Task class. これらの追加のパラメーターの一覧とその説明については、「 TaskExtension Base Class」を参照してください。For a list of these additional parameters and their descriptions, see TaskExtension Base Class.

Example

次のコード例では、すべての必須のプロパティが設定されていることを検証します。The following code example verifies that all required properties are set. 該当するプロパティが設定されていない場合、Error タスクの Text パラメーターの値をログに記録します。If they are not set, the project raises an error event, and logs the value of the Text parameter of the Error task.

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

関連項目See Also

Task Reference (タスク リファレンス) Task Reference
ビルド ログの取得Obtaining Build Logs