Write-Warning

Статья
10/30/2009

Записывает предупреждающее сообщение.

Синтаксис

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

Описание

Командлет Write-Warning записывает предупреждающее сообщение в основную программу Windows PowerShell. Реакция на предупреждение зависит от установленного пользователем значения переменной $WarningPreference и общего параметра WarningAction.

Параметры

-Message <string>

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

Обязательно?	true
Позиция?	1
Значение по умолчанию
Принимать входные данные из конвейера?	true (ByValue)
Принимать подстановочные знаки?	false

<CommonParameters>

Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.

Ввод и вывод

Входным типом является тип объектов, которые можно передавать командлету по конвейеру. Возвращаемым типом является тип объектов, возвращаемых командлетом.

Входные данные

System.String

Строку, содержащую предупреждение, можно передать командлету Write-Warning по конвейеру.

Выходные данные

Нет

Командлет Write-Warning осуществляет запись только в поток предупреждений. Он не формирует никакого другого вывода.

Примечания

По умолчанию переменная $WarningPreference имеет значение "Continue", что означает, что предупреждение отображается, после чего продолжается выполнение команды. Для определения допустимых значений привилегированной переменной, такой как $WarningPreference, присвойте ей строку из случайного набора знаков, например "abc". Допустимые значения будут выведены в сообщении об ошибке.

Пример 1

C:\PS>write-warning "This is only a test warning."

Описание
-----------
Эта команда выводит сообщение "ПРЕДУПРЕЖДЕНИЕ: This is only a test warning".

Пример 2

C:\PS>$w = "This is only a test warning."

C:\PS> $w | write-warning

Описание
-----------
В этом примере показано, что для передачи строки командлету Write-Warning можно использовать оператор конвейера (|). Строку можно сохранить в переменной, как показано в данной команде, либо передать непосредственно командлету Write-Warning по конвейеру.

Пример 3

C:\PS>$warningpreference

Continue

C:\PS> write-warning "This is only a test warning."
This is only a test warning.

C:\PS> $warningpreference = "SilentlyContinue"

C:\PS> write-warning "This is only a test warning."
C:\PS>

C:\PS> $warningpreference = "Stop"

C:\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 влияет на результат выполнения команды Write-Warning.

Первая команда выводит значение переменной $WarningPreference по умолчанию, которое равно "Continue". В результате при записи предупреждения сообщение о предупреждении выводится и продолжается выполнение.

В случае изменения значения переменной $WarningPreference результат выполнения команды Write-Warning снова изменяется. Значение "SilentlyContinue" подавляет появление предупреждения. Значение "Stop" отображает предупреждение, после чего прекращает выполнение команды.

Дополнительные сведения о переменной $WarningPreference см. в разделе about_Preference_Variables.

Пример 4

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

Описание
-----------
В этом примере показано, как изменение значения общего параметра WarningAction влияет на результат выполнения команды Write-Warning. Общий параметр WarningAction можно использовать с любым командлетом, чтобы определить, каким образом Windows PowerShell реагирует на создаваемые этим командлетом предупреждения. Общий параметр WarningAction переопределяет значение переменной $WarningPreference только для данной конкретной команды.

В этой команде командлет Write-Warning используется для отображения предупреждения. Значение Inquire параметра WarningAction указывает на то, что система должна выдать пользователю приглашение, когда команда выведет предупреждение.

Дополнительные сведения об общем параметре WarningAction см. в разделе about_CommonParameters.

См. также

Концепции

about_Preference_Variables
about_Commonparameters
Write-Debug
Write-Error
Write-Host
Write-Output
Write-Progress
Write-Verbose

Поделиться через