次の方法で共有

Write-Warning

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

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

構文

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変数を設定し、警告を書き込む

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

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.

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

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

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

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

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

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

パラメーター

-Message

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

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

入力

String

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

出力

None

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

メモ

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