Sdílet prostřednictvím

Write-Warning

  • Reference
Modul:
Microsoft.PowerShell.Utility

Zapíše zprávu s upozorněním.

Syntaxe

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

Description

Rutina Write-Warning zapíše do hostitele PowerShellu zprávu s upozorněním. Odpověď na upozornění závisí na hodnotě proměnné uživatele $WarningPreference a použití běžného parametru WarningAction .

Příklady

Příklad 1: Napsání zprávy s upozorněním

Tento příkaz zobrazí zprávu UPOZORNĚNÍ: Toto je pouze testovací upozornění.

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

Příklad 2: Předání řetězce do upozornění zápisu

Tento příkaz ukazuje, že k odeslání řetězce Write-Warningmůžete použít operátor kanálu (|) . Řetězec můžete uložit do proměnné, jak je znázorněno v tomto příkazu, nebo řetězec přeskakujte přímo na Write-Warning.

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

Příklad 3: Nastavení proměnné $WarningPreference a zápis upozornění

Tento příklad ukazuje účinek hodnoty $WarningPreference proměnné na Write-Warning příkaz.

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.

První příkaz zobrazí výchozí hodnotu $WarningPreference proměnné, což je Continue. V důsledku toho se při psaní upozornění zobrazí zpráva s upozorněním a bude pokračovat spuštění.

Když změníte hodnotu $WarningPreference proměnné, efekt Write-Warning příkazu se znovu změní. Hodnota SilentlyContinue potlačuje upozornění. Hodnota Stop zobrazí upozornění a pak zastaví spuštění příkazu.

Další informace o $WarningPreference proměnné najdete v tématu about_Preference_Variables.

Příklad 4: Nastavení parametru WarningAction a zápis upozornění

Tento příklad ukazuje účinek běžného parametru WarningAction na Write-Warning příkaz. Pomocí běžného parametru WarningAction s libovolnou rutinou můžete určit, jak PowerShell reaguje na upozornění vyplývající z daného příkazu. Běžný parametr WarningAction přepíše hodnotu $WarningPreference pouze pro tento konkrétní příkaz.

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"):

Tento příkaz používá rutinu Write-Warning k zobrazení upozornění. Běžný parametr WarningAction s hodnotou Inquire nasměruje systém k zobrazení výzvy uživateli, když příkaz zobrazí upozornění.

Další informace o společném parametru WarningAction najdete v tématu about_CommonParameters.

Parametry

-Message

Určuje zprávu upozornění.

Typ:String
Aliasy:Msg
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

Vstupy

String

Řetězec, který obsahuje upozornění na tuto rutinu, můžete převést na řetězec.

Výstupy

None

Tato rutina nevrátí žádný výstup. Zapisuje se jenom do datového proudu upozornění.

Poznámky

Výchozí hodnota proměnné $WarningPreference je Continue, která zobrazí upozornění a pak pokračuje v provádění příkazu. Chcete-li určit platné hodnoty pro proměnnou předvoleb, například $WarningPreference, nastavte ji na řetězec náhodných znaků, například "abc". Výsledná chybová zpráva obsahuje platné hodnoty.