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é $WarningPreference uživatele a použití WarningAction společný parametr.

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 Write-Warning

Tento příkaz ukazuje, že k odeslání řetězce do 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 do 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 proměnné $WarningPreference na příkaz 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.

První příkaz zobrazí výchozí hodnotu proměnné $WarningPreference, která 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 proměnné $WarningPreference, efekt příkazu Write-Warning se znovu změní. Hodnota SilentlyContinue potlačí upozornění. Hodnota Stop zobrazí upozornění a pak zastaví spuštění příkazu.

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

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

Tento příklad ukazuje účinek WarningAction společný parametr příkazu Write-Warning. Pomocí WarningAction společný parametr s libovolnou rutinou můžete určit, jak PowerShell reaguje na upozornění vyplývající z daného příkazu. WarningAction společný parametr 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í. WarningAction společný parametr s hodnotou Inquire směruje systém k zobrazení výzvy uživateli, když příkaz zobrazí upozornění.

Další informace o WarningAction společný parametr naleznete 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.