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 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.
Первая команда отображает значение по умолчанию переменной $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
Указывает предупреждение.
Тип: | String |
Aliases: | Msg |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
Входные данные
Можно передать строку, содержащую предупреждение для этого командлета.
Выходные данные
None
Этот командлет не возвращает выходные данные. Он записывает только в поток предупреждений.
Примечания
Значение по умолчанию для переменной $WarningPreference
равно Continue
, которая отображает предупреждение, а затем продолжает выполнять команду. Чтобы определить допустимые значения переменной предпочтения, например $WarningPreference
, задайте для нее строку случайных символов, например abc. Полученное сообщение об ошибке содержит допустимые значения.
Связанные ссылки
PowerShell