ToolTaskExtension 基本クラスToolTaskExtension Base Class

多くのタスクが ToolTaskExtension クラスを継承します。このクラスは ToolTask クラスから継承され、さらに、このクラス自体は Task から継承されます。Many tasks inherit from the ToolTaskExtension class, which inherits from the ToolTask class, which itself inherits from the Task class. この継承チェーンにより、これらのクラスから派生したタスクにいくつかのパラメーターが追加されます。This inheritance chain adds several parameters to the tasks that derive from them. このドキュメントでは、これらのパラメーターを示します。These parameters are listed in this document.

パラメーターParameters

基本クラスのパラメーターの説明を次の表に示します。The following table describes the parameters of the base classes.

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

タスクで使用できるビルド エンジン インターフェイスを指定します。Specifies the build engine interface available to tasks. ビルド エンジンは、自動的にこのパラメーターを設定して、タスクによるコールバックを可能にします。The build engine automatically sets this parameter to allow tasks to call back into it.
BuildEngine2 省略可能な IBuildEngine2 型のパラメーターです。Optional IBuildEngine2 parameter.

タスクで使用できるビルド エンジン インターフェイスを指定します。Specifies the build engine interface available to tasks. ビルド エンジンは、自動的にこのパラメーターを設定して、タスクによるコールバックを可能にします。The build engine automatically sets this parameter to allow tasks to call back into it.

この便利なプロパティにより、このクラスから継承するタスクの作成者は、IBuildEngine2 から IBuildEngine に値をキャストする必要がなくなります。This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.
BuildEngine3 省略可能な IBuildEngine3 型のパラメーターです。Optional IBuildEngine3 parameter.

ホストによって提供されるビルド エンジン インターフェイスを指定します。Specifies the build engine interface provided by the host.
EchoOff 省略可能な bool 型のパラメーターです。Optional bool parameter.

true に設定すると、このタスクは /Q を cmd.exe コマンド ラインに渡して、コマンド ラインが stdout にコピーされないようにします。When set to true, this task passes /Q to the cmd.exe command line such that the command line does not get copied to stdout.
EnvironmentVariables 省略可能な String 型の配列パラメーターです。Optional String array parameter.

等号で区切られた環境変数のペアの配列です。Array of pairs of environment variables, separated by equal signs. これらの変数は、標準の環境ブロックに加え (または標準の環境ブロックを選択的にオーバーライドして)、子の実行可能ファイルに渡されます。These variables are passed to the spawned executable in addition to, or selectively overriding, the regular environment block.
ExitCode 省略可能な Int32 型の読み取り専用出力パラメーターです。Optional Int32 output read-only parameter.

実行したコマンドの終了コードを示します。Specifies the exit code that is provided by the executed command. タスクがエラーを記録した一方で、プロセスの終了コードが 0 (成功) だった場合、これは -1 に設定されます。If the task logged any errors, but the process had an exit code of 0 (success), this is set to -1.
HostObject 省略可能な ITaskHost 型のパラメーターです。Optional ITaskHost parameter.

ホスト オブジェクト インスタンスを指定します (null も指定できます)。Specifies the host object instance (can be null). ビルド エンジンは、ホスト IDE によってホスト オブジェクトがこの特定のタスクに関連付けられている場合にこのプロパティを設定します。The build engine sets this property if the host IDE has associated a host object with this particular task.
Log 省略可能な TaskLoggingHelper 型の読み取り専用パラメーターです。Optional TaskLoggingHelper read-only parameter.

タスク ログ メソッドを格納している TaskLoggingHelperExtension クラスのインスタンスを取得します。Gets an instance of a TaskLoggingHelperExtension class that contains task logging methods.
LogStandardErrorAsError 省略可能な bool 型のパラメーターです。Option bool parameter.

true の場合、標準エラー ストリームで受け取ったすべてのメッセージがエラーとして記録されます。If true, all messages received on the standard error stream are logged as errors.
StandardErrorImportance 省略可能な String 型のパラメーターです。Optional String parameter.

標準出力ストリームのテキストを記録するときに使用する重要度です。Importance with which to log text from the standard out stream.
StandardOutputImportance 省略可能な String 型のパラメーターです。Optional String parameter.

標準出力ストリームのテキストを記録するときに使用する重要度です。Importance with which to log text from the standard out stream.
Timeout 仮想の省略可能な Int32 型のパラメーターです。Virtual optional Int32 parameter.

タスク実行を終了するまでの時間をミリ秒単位で指定します。Specifies the amount of time, in milliseconds, after which the task executable is terminated. 既定値は Int.MaxValue であり、タイムアウト期限がないことを示します。タイムアウトはミリ秒単位です。The default value is Int.MaxValue, indicating that there is no time out period.Time-out is in milliseconds.
ToolExe 仮想の省略可能な string 型のパラメーターです。Virtual optional string parameter.

プロジェクトで実装すると、ToolName をオーバーライドできます。Projects may implement this to override a ToolName. タスクでオーバーライドすると、ToolName を保持できます。Tasks may override this to preserve the ToolName.
ToolPath 省略可能な string 型のパラメーターです。Optional string parameter.

タスクで基になる実行可能ファイルを読み込む場所を指定します。Specifies the location from where the task loads the underlying executable file. このパラメーターを指定しないと、MSBuildMSBuild を実行しているフレームワークのバージョンに対応する SDK インストール パスが使用されます。If this parameter is not specified, the task uses the SDK installation path that corresponds to the version of the framework that is running MSBuildMSBuild.
UseCommandProcessor 省略可能な bool 型のパラメーターです。Optional bool parameter.

true に設定した場合、このタスクで直接コマンドを実行する代わりに、コマンド ラインのバッチ ファイルを作成し、そのファイルをコマンド プロセッサで実行します。When set to true, this task creates a batch file for the command line and executes it by using the command-processor instead of executing the command directly.
YieldDuringToolExecution 省略可能な bool 型のパラメーターです。Optional bool parameter.

true に設定した場合、このタスクは、その実行時にノードを生成します。When set to true, this task yields the node when its task is executing.

参照See Also

Task Reference (タスク リファレンス) Task Reference
タスクTasks