ToolTaskExtension 基底類別

許多工作會繼承 ToolTaskExtension 類別,而此類別本身又繼承 ToolTask 類別,後者再繼承自 Task 類別。 此繼承鏈結會將多個參數加入至從其中衍生的工作。 這些參數已於本文件中列出。

參數

下表說明基底類別的參數。

參數

描述

BuildEngine

選擇性 IBuildEngine 參數。

指定可供工作使用的建置引擎介面。 建置引擎會自動設定這個參數,以允許工作回呼至它。

BuildEngine2

選擇性 IBuildEngine2 參數。

指定可供工作使用的建置引擎介面。 建置引擎會自動設定這個參數,以允許工作回呼至它。

這是很便利的屬性,如此一來,從此類別繼承的工作作者就不需要將值從 IBuildEngine 轉換為 IBuildEngine2

BuildEngine3

選擇性 IBuildEngine3 參數。

指定由主機提供的建置引擎介面。

EchoOff

選擇性 bool 參數。

當設定為 true 時,此工作會傳遞 /Q 給 cmd.exe 命令列,這樣命令列就不會複製到 StdOut。

EnvironmentVariables

選擇性 String 陣列參數。

以等號分隔之環境變數組的陣列。 這些變數會傳遞給繁衍 (Spawn) 的可執行檔,以加入至 (或選擇性覆寫) 一般環境區塊。

ExitCode

選擇性 (Optional) Int32 輸出唯讀參數。

指定由執行的命令所提供的結束代碼 (Exit Code)。 如果工作記錄了任何錯誤,但是執行序的結束代碼為 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 時,這項工作就會在工作執行當中產生節點。

請參閱

概念

MSBuild 工作

其他資源

MSBuild 工作參考