Write-Warning

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Zapisuje komunikat ostrzegawczy.

Składnia

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

Opis

Polecenie Write-Warning cmdlet zapisuje komunikat ostrzegawczy na hoście programu PowerShell. Odpowiedź na ostrzeżenie zależy od wartości zmiennej użytkownika $WarningPreference i użycia wspólnego parametru WarningAction .

Przykłady

Przykład 1: Pisanie komunikatu ostrzegawczego

To polecenie wyświetla komunikat "OSTRZEŻENIE: jest to tylko ostrzeżenie testowe".

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

Przykład 2. Przekazywanie ciągu do ostrzeżenia zapisu

To polecenie pokazuje, że możesz użyć operatora potoku (|), aby wysłać ciąg do Write-Warning. Możesz zapisać ciąg w zmiennej, jak pokazano w tym poleceniu, lub przekazać ciąg bezpośrednio do Write-Warning.

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

Przykład 3. Ustawianie zmiennej $WarningPreference i zapisywanie ostrzeżenia

W tym przykładzie pokazano wpływ wartości zmiennej $WarningPreference na Write-Warning polecenie.

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.

Pierwsze polecenie wyświetla domyślną wartość zmiennej $WarningPreference , czyli Continue. W związku z tym po zapisie ostrzeżenia zostanie wyświetlony komunikat ostrzegawczy i wykonanie będzie kontynuowane.

Po zmianie wartości $WarningPreference zmiennej efekt Write-Warning polecenia zmieni się ponownie. Wartość SilentlyContinue pomija ostrzeżenie. Wartość Stop wyświetla ostrzeżenie, a następnie zatrzymuje wykonywanie polecenia.

Aby uzyskać więcej informacji na temat zmiennej $WarningPreference , zobacz about_Preference_Variables.

Przykład 4. Ustawianie parametru WarningAction i zapisywanie ostrzeżenia

W tym przykładzie pokazano efekt wspólnego parametru WarningAction w poleceniu Write-Warning . Możesz użyć wspólnego parametru WarningAction z dowolnym poleceniem cmdlet, aby określić sposób, w jaki program PowerShell reaguje na ostrzeżenia wynikające z tego polecenia. Wspólny parametr WarningAction zastępuje wartość jedynego $WarningPreference dla tego konkretnego polecenia.

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

To polecenie używa Write-Warning polecenia cmdlet do wyświetlenia ostrzeżenia. Wspólny parametr WarningAction z wartością Inquire przekierowuje system, aby monitować użytkownika, gdy polecenie wyświetli ostrzeżenie.

Aby uzyskać więcej informacji na temat wspólnego parametru WarningAction , zobacz about_CommonParameters.

Parametry

-Message

Określa komunikat ostrzegawczy.

Type:String
Aliases:Msg
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Dane wejściowe

String

Możesz przekazać ciąg zawierający ostrzeżenie do tego polecenia cmdlet.

Dane wyjściowe

None

To polecenie cmdlet nie zwraca żadnych danych wyjściowych. Zapisuje tylko w strumieniu ostrzegawczym.

Uwagi

Wartość domyślna zmiennej $WarningPreference to Continue, która wyświetla ostrzeżenie, a następnie kontynuuje wykonywanie polecenia. Aby określić prawidłowe wartości zmiennej preferencji, takiej jak $WarningPreference, ustaw ją na ciąg losowych znaków, taki jak "abc". Wynikowy komunikat o błędzie zawiera listę prawidłowych wartości.