Write-Debug
將偵錯訊息寫入主控台。
語法
Write-Debug
[-Message] <String>
[<CommonParameters>]
Description
Cmdlet Write-Debug
會從腳本或命令將偵錯訊息寫入主機。
根據預設,偵錯訊息不會顯示在控制台中,但您可以使用Debug參數或$DebugPreference
變數來顯示它們。
範例
範例 1:瞭解$DebugPreference
此範例會寫入偵錯訊息。
Write-Debug "Cannot open file."
的預設值 $DebugPreference
為 SilentlyContinue。 因此,訊息不會顯示在控制台中。
範例 2:變更 $DebugPreference 的值
這個範例顯示變更變數值 $DebugPreference
的效果。 首先,我們會顯示 的目前值 $DebugPreference
,並嘗試寫入偵錯訊息。 然後,我們將的值 $DebugPreference
變更為 [繼續],以允許顯示偵錯訊息。
PS> $DebugPreference
SilentlyContinue
PS> Write-Debug "Cannot open file."
PS>
PS> $DebugPreference = "Continue"
PS> Write-Debug "Cannot open file."
DEBUG: Cannot open file.
如需 的詳細資訊 $DebugPreference
,請參閱 about_Preference_Variables。
範例 3:使用 Debug 参數覆寫$DebugPreference
函 Test-Debug
式會將變數的值 $DebugPreference
寫入 PowerShell 主機和偵錯數據流。 在此範例中 ,我們使用Debug 參數來覆寫 $DebugPreference
值。
function Test-Debug {
[CmdletBinding()]
param()
Write-Debug ('$DebugPreference is ' + $DebugPreference)
Write-Host ('$DebugPreference is ' + $DebugPreference)
}
PS> Test-Debug
$DebugPreference is SilentlyContinue
PS> Test-Debug -Debug
DEBUG: $DebugPreference is Inquire
Confirm
Continue with this operation?
[Y] Yes [A] Yes to All [H] Halt Command [?] Help (default is "Y"):
$DebugPreference is Inquire
PS> $DebugPreference
SilentlyContinue
請注意,當您使用Debug參數時,變更$DebugPreference
的值。 這項變更只會影響函式的範圍。 值不會在函式外部受到影響。
注意
當 的值 $DebugPreference
是 [查詢] 時,PowerShell 會停止執行,詢問是否應該繼續執行。
如需偵錯一般參數的詳細資訊,請參閱 about_CommonParameters。
參數
-Message
指定要傳送至主控台的偵錯訊息。
類型: | String |
別名: | Msg |
Position: | 0 |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
輸入
您可以使用管線將包含偵錯訊息的字串傳送至此 Cmdlet。
輸出
None
此 Cmdlet 不會傳回任何輸出。 它只會寫入偵錯數據流。