Write-Debug

模块:: Microsoft.PowerShell.Utility Module

将调试消息写入控制台。

语法

Default （默认值）

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

说明

Write-Debug cmdlet 从脚本或命令将调试消息写入主机。

默认情况下，调试消息不会显示在控制台中，但可以使用 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 Continue
$DebugPreference is Continue
PS> $DebugPreference
SilentlyContinue

请注意，使用 $DebugPreference 参数时，的值会更改。此更改仅影响函数的范围。该值在函数外部不受影响。

有关 Debug 通用参数的详细信息，请参阅 about_CommonParameters。

参数

-Message

指定要发送到控制台的调试消息。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False
别名:	味精

参数集

(All)

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。