ToolTaskExtension 基底類別
許多工作繼承自 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 時,這項工作在執行其工作時,會產生節點。 |