Write-Host

Статья
10/30/2009

Записывает в основную программу пользовательский вывод.

Синтаксис

Write-Host [[-Object] <Object>] [-BackgroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-ForegroundColor {<Black> | <DarkBlue> | <DarkGreen> | <DarkCyan> | <DarkRed> | <DarkMagenta> | <DarkYellow> | <Gray> | <DarkGray> | <Blue> | <Green> | <Cyan> | <Red> | <Magenta> | <Yellow> | <White>}] [-NoNewline] [-Separator <Object>] [<CommonParameters>]

Описание

Командлет Write-Host позволяет управлять выводом. Можно указать цвет текста с помощью параметра ForegroundColor, а также фоновый цвет, используя параметр BackgroundColor. Параметр Separator позволяет указать строку, которая будет использоваться для разделения отображаемых объектов. Конкретный результат зависит от основной программы, из которой запускается Windows PowerShell.

Параметры

-BackgroundColor <ConsoleColor>

Задает цвет фона. Значение по умолчанию отсутствует.

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

-ForegroundColor <ConsoleColor>

Задает цвет текста. Значение по умолчанию отсутствует.

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

-NoNewline

Указывает, что содержимое, отображаемое в консоли, не заканчивается знаком новой строки.

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

-Object <Object>

Объекты, отображаемые в консоли.

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

-Separator <Object>

Строка для вывода между объектами, отображаемыми на консоли.

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

<CommonParameters>

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

Ввод и вывод

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

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

System.Object

Объекты, записываемые в основной программе, можно передавать по конвейеру.

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

Нет

Командлет Write-Host отправляет объекты основной программе. Он не возвращает никаких объектов. Однако основная программа может отобразить полученные с помощью командлета Write-Host объекты.

Пример 1

C:\PS>write-host "no newline test " -nonewline

no newline test C:\PS>

Описание
-----------
Эта команда отображает вывод на консоли, но из-за наличия параметра NoNewline за выводом сразу же следует приглашение командной строки.

Пример 2

C:\PS>write-host (2,4,6,8,10,12) -Separator ", +2= "

2, +2= 4, +2= 6, +2= 8, +2= 10, +2= 12

Описание
-----------
Эта команда отображает четные числа от 2 до 12. Параметр Separator используется для добавления строки ", +2= " (запятая, пробел, +, 2, =, пробел).

Пример 3

C:\PS>write-host (2,4,6,8,10,12) -Separator ", -> " -foregroundcolor DarkGreen -backgroundcolor white

Описание
-----------
Эта команда отображает четные числа от 2 до 12. Параметр ForegroundColor определяет темно-зеленый цвет выводимого текста, а параметр BackgroundColor — белый фон.

Пример 4

C:\PS>write-host "Red on white text." -ForegroundColor red -BackgroundColor white

Red on white text.

Описание
-----------
Эта команда отображает строку "Red on white text.". Текст отображается красным в соответствии со значением параметра ForegroundColor. Фон отображается белым в соответствии со значением параметра BackgroundColor.

См. также

Концепции

Write-Verbose
Write-Error
Write-Progress
Write-Debug
Write-Output
Write-Warning
Out-Host

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