Write-Warning
Записывает предупреждающее сообщение.
Синтаксис
Write-Warning
[-Message] <String>
[<CommonParameters>]
Описание
Командлет Write-Warning
записывает предупреждающее сообщение на узел PowerShell. Ответ на предупреждение зависит от значения переменной пользователя $WarningPreference
и использования общего параметра WarningAction .
Примеры
Пример 1. Написание предупреждающего сообщения
Эта команда отображает сообщение "ПРЕДУПРЕЖДЕНИЕ: это только тестовое предупреждение".
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 и запись предупреждения
В этом примере показано влияние значения переменной на $WarningPreference
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 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."
Первая команда отображает значение по умолчанию для переменной $WarningPreference
, то есть Continue
. В результате при записи предупреждения отображается предупреждающее сообщение и продолжается выполнение команды.
При изменении значения переменной $WarningPreference
действие Write-Warning
команды снова меняется. Значение SilentlyContinue
подавляет предупреждение. Значение Stop
отображает предупреждение, а затем останавливает выполнение команды.
Дополнительные сведения о переменной см. в $WarningPreference
разделе about_Preference_Variables.
Пример 4. Установка параметра WarningAction и запись предупреждения
В этом примере показано влияние общего параметра WarningAction на Write-Warning
команду. Общий параметр 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
Указывает предупреждающее сообщение.
Type: | String |
Aliases: | Msg |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Входные данные
Можно передать строку, содержащую предупреждение, в Write-Warning
.
Выходные данные
None
Write-Warning
записывает только в поток предупреждений. Он не формирует каких-либо других выходных данных.
Примечания
Значение по умолчанию для переменной $WarningPreference
— Continue
, которая отображает предупреждение и продолжает выполнение команды. Чтобы определить допустимые значения для переменной предпочтения, например $WarningPreference
, задайте для нее строку случайных символов, например "abc". В полученном сообщении об ошибке перечислены допустимые значения.