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

Write-Host

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Записывает пользовательские выходные данные в узел.

Синтаксис

Write-Host
     [[-Object] <Object>]
     [-NoNewline]
     [-Separator <Object>]
     [-ForegroundColor <ConsoleColor>]
     [-BackgroundColor <ConsoleColor>]
     [<CommonParameters>]

Описание

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

Примечание

Начиная с Windows PowerShell 5.0, Write-Host является оболочкой для Write-Information этого позволяет использовать Write-Host для выдачи выходных данных в информационный поток. Это позволяет захватывать или подавлять данные, записанные с помощью , Write-Host сохраняя обратную совместимость.

Переменная $InformationPreference предпочтения и InformationAction общий параметр не влияют на Write-Host сообщения. Исключением из этого правила является -InformationAction Ignore, которое эффективно подавляет выходные Write-Host данные. (см. пример 5)

Примеры

Пример 1. Запись в консоль без добавления новой строки

Write-Host "no newline test " -NoNewline
Write-Host "second string"

no newline test second string

Эта команда отображает строку no newline test с параметром NoNewline .

Вторая строка записывается, но она заканчивается на той же строке, что и первая из-за отсутствия новой строки, разделяющей строки.

Пример 2. Запись в консоль и включение разделителя

Write-Host (2,4,6,8,10,12) -Separator ", +2= "

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

Эта команда отображает четные числа от двух до двенадцати. Параметр Разделитель используется для добавления строки , +2= (comma, space, +, 2, =, space).

Пример 3. Запись с разными цветами текста и фона

Write-Host (2,4,6,8,10,12) -Separator ", -> " -ForegroundColor DarkGreen -BackgroundColor White

2, -> 4, -> 6, -> 8, -> 10, -> 12

Эта команда отображает четные числа от двух до двенадцати. Он использует параметр для ForegroundColor вывода "темно-зеленого" текста и BackgroundColor параметр для отображения "белого" фона.

Пример 4. Запись с разными цветами текста и фона

Write-Host "Red on white text." -ForegroundColor red -BackgroundColor white

Red on white text.

Эта команда отображает строку "Красный на белом тексте". Текст имеет значение "red" в соответствии с параметром ForegroundColor . Фон имеет значение "белый", как определено параметром BackgroundColor .

Пример 5. Подавление выходных данных из Write-Host

# The following two statements can be used to effectively suppress output from Write-Host
Write-Host "I won't print" -InformationAction Ignore
Write-Host "I won't print" 6>$null

Эта команда отображает строку "Красный на белом тексте". Текст имеет значение "red" в соответствии с параметром ForegroundColor . Фон имеет значение "белый", как определено параметром BackgroundColor .

Параметры

-BackgroundColor

Определяет цвет фона. Значение по умолчанию отсутствует. Допустимые значения для этого параметра:

  • Черный
  • DarkBlue
  • Темно-зеленая
  • DarkCyan
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • Серый
  • DarkGray
  • Синий
  • Зеленый
  • Голубой
  • Красный
  • Пурпурный
  • Желтый
  • White
Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForegroundColor

Определяет цвет текста. Значение по умолчанию отсутствует. Допустимые значения для этого параметра:

  • Черный
  • DarkBlue
  • Темно-зеленая
  • DarkCyan
  • DarkRed
  • DarkMagenta
  • DarkYellow
  • Серый
  • DarkGray
  • Синий
  • Зеленый
  • Голубой
  • Красный
  • Пурпурный
  • Желтый
  • White
Type:ConsoleColor
Accepted values:Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-NoNewline

Строковые представления входных объектов объединяются для формирования выходных данных. Пробелы или новые строки не вставляются между выходными строками. После последней выходной строки новая строка не добавляется.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Object

Объекты, отображаемые на узле.

Type:Object
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Separator

Задает строку-разделитель для вставки между объектами, отображаемыми узлом.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Object

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

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

None

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