Write-Warning (Microsoft.PowerShell.Utility)

Write-Warning

Модуль:

Microsoft.PowerShell.Utility

Пишет предупреждающее сообщение.

Синтаксис

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 снова меняется. Значение SillyContinue подавляет предупреждение. Значение 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

Псевдонимы:

Msg

Позиция:

0

Значение по умолчанию:

None

Необходимый:

True

Примите ввод конвейера:

True

Принимайте подстановочные знаки:

False

Входы

Строка

Вы можете передать этому командлету строку, содержащую предупреждение.

Выходы

Нет

Этот командлет не возвращает никаких результатов. Он пишет только в поток предупреждений.

Примечания

Значением по умолчанию для переменной $WarningPreference является Continue, которое отображает предупреждение и затем продолжает выполнение команды. Чтобы определить допустимые значения для привилегированной переменной, такой как $WarningPreference, задайте для нее строку случайных символов, например «abc». В полученном сообщении об ошибке перечислены допустимые значения.