Write-Warning

モジュール:: Microsoft.PowerShell.Utility

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

構文

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

説明

Write-Warning コマンドレットは、Windows PowerShell ホストに警告メッセージを書き込みます。警告に対する応答は、ユーザーの $WarningPreference 変数の値と WarningAction 共通パラメーターの使用によって異なります。

例

例 1: 警告メッセージを書き込む

PS C:\> Write-Warning "This is only a test warning."

このコマンドは、"WARNING: This is only a test warning" というメッセージを表示します。

例 2: 文字列を Write-Warning に渡す

PS C:\> $w = "This is only a test warning."
PS C:\> $w | Write-Warning

このコマンドは、パイプライン演算子 (|) を使用して文字列を Write-Warning に送信できることを示しています。このコマンドに示すように、文字列を変数に保存するか、文字列を直接 Write-Warning にパイプ処理できます。

例 3: $WarningPreference変数を設定し、警告を書き込む

PS C:\> $warningpreference
Continue PS C:\> Write-Warning "This is only a test warning."
This is only a test warning. PS C:\> $warningpreference = "SilentlyContinue"
PS C:\> Write-Warning "This is only a test warning."
PS C:\>
PS C:\> $warningpreference = "Stop"
PS C:\> 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."

次の例は、 Write-Warning コマンドに対する $WarningPreference 変数の値の影響を示しています。

最初のコマンドは、$WarningPreference変数のデフォルト値である Continue を表示します。その結果、警告を記述すると、警告メッセージが表示され、実行が続行されます。

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

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

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

PS C:\> 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 コマンドに対する WarningAction 共通パラメータの影響を示します。任意のコマンドレットで WarningAction 共通パラメーターを使用して、そのコマンドの結果として発生する警告に Windows PowerShell がどのように応答するかを決定できます。 WarningAction 共通パラメーターは、その特定のコマンドに対してのみ$WarningPreferenceの値をオーバーライドします。

このコマンドでは、 Write-Warning コマンドレットを使用して警告を表示します。 WarningAction 共通パラメーターの値が Inquire の場合、コマンドが警告を表示したときにユーザーにプロンプトを表示するようにシステムに指示します。

WarningAction 共通パラメータの詳細については、about_CommonParametersを参照してください。

パラメーター

-Message

警告メッセージを指定します。

型:	String
Aliases:	Msg
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

入力

String

警告を含む文字列を Write-Warning にパイプ処理できます。

出力

None

Write-Warning は 、警告ストリームにのみ書き込みます。他の出力は生成されません。

メモ

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