Write-Warning

警告メッセージを書き込みます。

構文

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

説明

コマンドレットは 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変数を設定し、警告を書き込む

この例では、変数の値がコマンドに $WarningPreference 与える影響を Write-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 warning.
Write-Warning: The running command stopped because the preference variable "WarningPreference" or common parameter is set to Stop: This is only a test warning.

最初のコマンドは、Continue変数の既定値を$WarningPreference表示します。 この結果、警告メッセージが表示された後も実行が継続されます。

変数の $WarningPreference 値を変更すると、コマンドの効果が Write-Warning 再び変わります。 値を指定 SilentlyContinue すると、警告が抑制されます。 値を指定 Stop すると警告が表示され、コマンドの実行が停止されます。

$WarningPreference 変数の詳細については、「about_Preference_Variables」を参照してください。

例 4: WarningAction パラメーターを設定し、警告を書き込む

この例では、WarningAction 共通パラメーターがコマンドに与える影響をWrite-Warning示します。 WarningAction 共通パラメーターは、任意のコマンドレットと共に使用して、そのコマンドによって生成される警告に対する 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 使用して警告を表示します。 値が 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

警告を含む文字列をこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。 警告ストリームにのみ書き込みます。

メモ

変数の $WarningPreference 既定値は Continue、警告を表示し、コマンドの実行を続行します。 基本設定変数の $WarningPreference有効な値を決定するには、"abc" などのランダムな文字の文字列に設定します。 結果のエラー メッセージには、有効な値が一覧表示されます。