ToolTaskExtension Base Class

 

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件

許多工作繼承自 ToolTaskExtension 類別,該類別繼承自 ToolTask 類別,而其本身是繼承自 Task 類別。 此繼承鏈結將數個參數加入至從它們衍生的工作。 本文件會列出這些參數。

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

參數描述
BuildEngine選擇性的 IBuildEngine 參數。

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

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

這是方便的屬性,讓工作作者繼承自這個類別,不需要將值從 IBuildEngine 轉型到 IBuildEngine2
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 參數。

指定位置,工作會從該位置載入基礎可執行檔。 如果未指定這個參數,工作會使用 SDK 安裝路徑,對應於執行 MSBuild 之架構的版本。
UseCommandProcessor選擇性的 bool 參數。

當設為 true 時,這項工作會針對命令列建立批次檔,並且使用命令處理器來執行,而不是直接執行命令。
YieldDuringToolExecution選擇性的 bool 參數。

當設為 true 時,這項工作在執行其工作時,會產生節點。

Task Reference
工作

顯示: