Write-Warning

写入一条警告消息。

语法

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

说明

cmdlet Write-Warning 会将警告消息写入 PowerShell 主机。 对警告的响应取决于用户 $WarningPreference 变量的值以及 WarningAction 通用参数的使用。

示例

示例 1:写入警告消息

此命令显示消息“WARNING: This is only a test warning”。

Write-Warning "This is only a test warning."

示例 2:将字符串传递给 Write-Warning

此命令显示可以使用管道运算符 (|) 将字符串发送到 Write-Warning。 可以将字符串保存在变量中(如此命令中所示),也可以将字符串直接通过管道传递给 Write-Warning

$w = "This is only a test warning."
$w | Write-Warning

示例 3:设置 $WarningPreference 变量并写入警告

此示例演示变量值 $WarningPreferenceWrite-Warning 命令的影响。

PS> $WarningPreference
Continue
PS> Write-Warning "This is only a test warning."
This is only a test warning.
PS> $WarningPreference = "SilentlyContinue"
PS> Write-Warning "This is only a test warning."
PS> $WarningPreference = "Stop"
PS> Write-Warning "This is only a test warning."
WARNING: This is only a test message.
Write-Warning : Command execution stopped because the shell variable "WarningPreference" is set to Stop.
At line:1 char:14
     + Write-Warning <<<<  "This is only a test message."

第一个命令显示变量的 $WarningPreference 默认值,即 Continue。 因此,当你编写一条警告时,将显示警告消息,并且继续执行。

更改变量的值 $WarningPreference 时,命令的效果 Write-Warning 会再次更改。 如果值为 , SilentlyContinue 则取消显示警告。 值 显示 Stop 警告,然后停止执行命令。

有关变量 $WarningPreference 的详细信息,请参阅 about_Preference_Variables

示例 4:设置 WarningAction 参数并写入警告

此示例演示 WarningAction 公共参数对 Write-Warning 命令的影响。 可以将 WarningAction 通用参数与任何 cmdlet 一起使用,以确定 PowerShell 如何响应该命令产生的警告。 WarningAction 通用参数仅覆盖该特定命令的 的值$WarningPreference

PS> Write-Warning "This is only a test warning." -WarningAction Inquire
WARNING: This is only a test warning.
Confirm
Continue with this operation?
 [Y] Yes  [A] Yes to All  [H] Halt Command  [S] Suspend  [?] Help (default is "Y"):

此命令使用 Write-Warning cmdlet 显示警告。 值为 Inquire 的 WarningAction 通用参数指示系统在该命令显示警告时提示用户。

有关 WarningAction 通用参数的详细信息,请参阅 about_CommonParameters

参数

-Message

指定警告消息。

Type:String
Aliases:Msg
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

输入

String

可以通过管道将包含警告的字符串传递给 Write-Warning

输出

None

Write-Warning 仅写入警告流。 它不生成任何其他输出。

备注

变量的 $WarningPreference 默认值为 Continue,它显示警告,然后继续执行命令。 若要确定首选项变量(如 $WarningPreference)的有效值,请将其设置为随机字符(如“abc”)的字符串。 生成的错误消息列出了有效值。