共用方式為

Write-Debug

  • 參考
模組:
Microsoft.PowerShell.Utility

將偵錯訊息寫入主控台。

語法

Write-Debug
     [-Message] <String>
     [<CommonParameters>]

Description

Write-Debug Cmdlet 會從腳本或命令將偵錯訊息寫入主控台。

根據預設，偵錯訊息不會顯示在控制台中，但您可以使用 Debug 參數或 $DebugPreference 變數來顯示訊息。

範例

範例 1：瞭解$DebugPreference

此範例會寫入偵錯訊息。

Write-Debug "Cannot open file."

$DebugPreference 預設值為 SilentlyContinue。 因此，訊息不會顯示在控制台中。

範例 2：變更 $DebugPreference 的值

此範例顯示變更 $DebugPreference 變數值的效果。 首先，我們會顯示目前 $DebugPreference 值，並嘗試寫入偵錯訊息。 然後，我們將 $DebugPreference 的值變更為 Continue，以允許顯示偵錯訊息。

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 的值會變更。 這項變更只會影響函式的範圍。 值不會在函式外部受到影響。

注意

當查詢 的值時，PowerShell 會停止執行，詢問是否應該繼續執行。

如需 偵錯 一般參數的詳細資訊，請參閱 about_CommonParameters。

參數

-Message

指定要傳送至主控台的偵錯訊息。

類型:String
別名:Msg
Position:0
預設值:None
必要:True
接受管線輸入:True
接受萬用字元:False

輸入

String

您可以使用管線將包含偵錯訊息的字串傳送至 Write-Debug。

輸出

None

Write-Debug 只會寫入偵錯數據流。 它不會傳回任何輸出。