ToolTaskExtension 基本クラス
多くのタスクが ToolTaskExtension クラスを継承します。このクラスは ToolTask クラスから継承され、さらに、このクラス自体は Task から継承されます。 この継承チェーンにより、これらのクラスから派生したタスクにいくつかのパラメーターが追加されます。 このドキュメントでは、これらのパラメーターを示します。
パラメーター
基本クラスのパラメーターの説明を次の表に示します。
| パラメーター | 説明 |
|---|---|
| BuildEngine | 省略可能な IBuildEngine 型のパラメーターです。 タスクで使用できるビルド エンジン インターフェイスを指定します。 ビルド エンジンは、自動的にこのパラメーターを設定して、タスクによるコールバックを可能にします。 |
| BuildEngine2 | 省略可能な IBuildEngine2 型のパラメーターです。 タスクで使用できるビルド エンジン インターフェイスを指定します。 ビルド エンジンは、自動的にこのパラメーターを設定して、タスクによるコールバックを可能にします。 この便利なプロパティにより、このクラスから継承するタスクの作成者は、 IBuildEngine2 から IBuildEngine に値をキャストする必要がなくなります。 |
| BuildEngine3 | 省略可能な IBuildEngine3 型のパラメーターです。 ホストによって提供されるビルド エンジン インターフェイスを指定します。 |
| EchoOff | 省略可能な bool 型のパラメーターです。true に設定すると、このタスクは /Q を cmd.exe コマンド ラインに渡して、コマンド ラインが stdout にコピーされないようにします。 |
| EnvironmentVariables | 省略可能な String 型の配列パラメーターです。等号で区切られた環境変数のペアの配列です。 これらの変数は、標準の環境ブロックに加え (または標準の環境ブロックを選択的にオーバーライドして)、子の実行可能ファイルに渡されます。 |
| ExitCode | 省略可能な Int32 型の読み取り専用出力パラメーターです。実行したコマンドの終了コードを示します。 タスクがエラーを記録した一方で、プロセスの終了コードが 0 (成功) だった場合、これは -1 に設定されます。 |
| HostObject | 省略可能な ITaskHost 型のパラメーターです。 ホスト オブジェクト インスタンスを指定します (null も指定できます)。 ビルド エンジンは、ホスト IDE によってホスト オブジェクトがこの特定のタスクに関連付けられている場合にこのプロパティを設定します。 |
| Log | 省略可能な TaskLoggingHelper 型の読み取り専用パラメーターです。 タスク ログ メソッドを格納している TaskLoggingHelperExtension クラスのインスタンスを取得します。 |
| LogStandardErrorAsError | 省略可能な bool 型のパラメーターです。true の場合、標準エラー ストリームで受け取ったすべてのメッセージがエラーとして記録されます。 |
| StandardErrorImportance | 省略可能な String 型のパラメーターです。標準出力ストリームのテキストを記録するときに使用する重要度です。 |
| StandardOutputImportance | 省略可能な String 型のパラメーターです。標準出力ストリームのテキストを記録するときに使用する重要度です。 |
| Timeout | 仮想の省略可能な Int32 型のパラメーターです。タスク実行を終了するまでの時間をミリ秒単位で指定します。 既定値は Int.MaxValue であり、タイムアウト期限がないことを示します。 タイムアウトはミリ秒単位です。 |
| ToolExe | 仮想の省略可能な string 型のパラメーターです。プロジェクトで実装すると、ToolName をオーバーライドできます。 タスクでオーバーライドすると、ToolName を保持できます。 |
| ToolPath | 省略可能な string 型のパラメーターです。タスクで基になる実行可能ファイルを読み込む場所を指定します。 このパラメーターを指定しない場合、タスクでは、MSBuild を実行しているフレームワークのバージョンに対応する SDK インストール パスが使用されます。 |
| UseCommandProcessor | 省略可能な bool 型のパラメーターです。true に設定した場合、このタスクで直接コマンドを実行する代わりに、コマンド ラインのバッチ ファイルを作成し、そのファイルをコマンド プロセッサで実行します。 |
| YieldDuringToolExecution | 省略可能な bool 型のパラメーターです。true に設定した場合、このタスクは、その実行時にノードを生成します。 |