Write-Debug
将调试消息写入控制台。
语法
Write-Debug
[-Message] <String>
[<CommonParameters>]
说明
cmdlet Write-Debug
通过脚本或命令将调试消息写入控制台。
默认情况下,调试消息不会显示在控制台中,但你可以使用 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
的值会更改。 此更改仅影响函数的范围。 值在函数外部不受影响。
注意
当 的 $DebugPreference
值为 “查询”时,PowerShell 会停止执行以询问是否应继续执行。
有关 Debug 通用参数的详细信息,请参阅 about_CommonParameters。
参数
-Message
指定要发送到控制台的调试消息。
Type: | String |
Aliases: | Msg |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
输入
可以通过管道将包含调试消息的字符串传递给 Write-Debug
。
输出
None
Write-Debug
仅写入调试流。 它不返回任何输出。