Write-Debug
将调试消息写入控制台。
语法
Write-Debug [-Message] <string> [<CommonParameters>]
说明
Write-Debug cmdlet 将调试消息从脚本或命令写入控制台。
默认情况下,调试消息不会显示在控制台中,但您可以使用 Debug 参数或 $DebugPreference 变量来显示它们。
参数
-Message <string>
指定要发送到控制台的调试消息。
是否为必需? |
true |
位置? |
1 |
默认值 |
|
是否接受管道输入? |
true (ByValue) |
是否接受通配符? |
false |
<CommonParameters>
此 cmdlet 支持通用参数:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息,请参阅 about_Commonparameters.
输入和输出
输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。
输入 |
System.String 可以通过管道将包含调试消息的字符串传递给 Write-Debug。 |
输出 |
无 Write-Debug 只写入调试流。它不返回任何输出。 |
示例 1
C:\PS>Write-Debug "Cannot open file."
说明
-----------
此命令会写入一条调试消息。由于 $DebugPreference 的值是“SilentlyContinue”,因此该消息不会显示在控制台中。
示例 2
C:\PS>$DebugPreference
SilentlyContinue
C:\PS> Write-Debug "Cannot open file."
C:\PS>
C:\PS> Write-Debug "Cannot open file." -debug
DEBUG: Cannot open file.
说明
-----------
此示例演示了如何使用 Debug 通用参数来重写特定命令的 $DebugPreference 变量的值。
第一条命令显示 $DebugPreference 变量的值,默认情况下该值为“SilentlyContinue”。
第二条命令写入一条调试消息,但由于 $DebugPreference 值的原因,该消息不会显示。
第三条命令写入一条调试消息。它使用 Debug 通用参数来重写 $DebugPreference 的值,并显示此命令生成的调试消息。
因此,即使 $DebugPreference 的值是“SilentlyContinue”,也会显示调试消息。
有关 Debug 通用参数的详细信息,请参阅 about_CommonParameters。
示例 3
C:\PS>$DebugPreference
SilentlyContinue
C:\PS> Write-Debug "Cannot open file."
C:\PS>
C:\PS> $DebugPreference = "Continue"
C:\PS> Write-Debug "Cannot open file."
DEBUG: Cannot open file.
说明
-----------
此命令显示更改 $DebugPreference 变量的值对显示调试消息的影响。
第一条命令显示 $DebugPreference 变量的值,默认情况下该值为“SilentlyContinue”。
第二条命令写入一条调试消息,但由于 $DebugPreference 值的原因,该消息不会显示。
第三条命令为 $DebugPreference 变量赋予值“Continue”。
第四条命令写入一条调试消息,该消息会出现在控制台上。
有关 $DebugPreference 的详细信息,请参阅 about_Preference_Variables。
另请参阅
概念
Write-Verbose
Write-Error
Write-Host
Write-Progress
Write-Output
Write-Warning