次の方法で共有

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 の値を指定すると、警告が抑制されます。 [停止] の値を指定すると、警告が表示され、コマンドの実行が停止されます。

$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 コマンドレットを使用して警告を表示します。 値が 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

書き込み警告 は、警告ストリームにのみ書き込みます。 その他の出力は生成しません。

メモ

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