Out-Host
Отправляет вывод в командную строку.
Синтаксис
Out-Host [-InputObject <psobject>] [-Разбивка на страницы] [<CommonParameters>]
Описание
Командлет Out-Host отправляет вывод основному приложению Windows PowerShell для отображения. Основное приложение отображает вывод в командной строке. Так как командлет Out-Host используется по умолчанию, его можно не указывать, если только не нужно с помощью его параметров изменить способ отображения данных.
Параметры
-InputObject <psobject>
Задает объекты, которые будут выведены на консоль. Введите переменную, содержащую объекты, либо команду или выражение для получения объектов.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
true (ByValue) |
Принимать подстановочные знаки? |
false |
-Разбивка на страницы
Отображает по одной странице вывода и ждет ввода пользователя для отображения следующих страниц, как и традиционная команда "more". По умолчанию все выходные данные отображаются на одной странице. Размер страницы определяется характеристиками основного приложения.
Обязательно? |
false |
Позиция? |
named |
Значение по умолчанию |
|
Принимать входные данные из конвейера? |
false |
Принимать подстановочные знаки? |
false |
<CommonParameters>
Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.
Ввод и вывод
Входным типом является тип объектов, которые можно передавать командлету по конвейеру. Возвращаемым типом является тип объектов, возвращаемых командлетом.
Входные данные |
System.Management.Automation.PSObject Любой объект можно передать командлету Out-Host по конвейеру. |
Выходные данные |
Нет Командлет Out-Host не формирует никаких выходных данных. Однако основная программа может отображать полученные с помощью командлета Out-Host объекты. |
Примечания
Командлет Out-Host также можно вызывать с помощью встроенного псевдонима "oh". Дополнительные сведения см. в разделе About_Aliases.
Командлеты, содержащие команду Out (командлеты Out) не форматируют объекты, а только обрабатывают их и отправляют в указанное назначение для отображения. Если передать неформатированный объект в командлет Out, он перед обработкой отправит его в форматирующий командлет.
Командлеты Out не содержат параметров для указания имен или путей. Для передачи данных командлету Out используйте оператор конвейера (|), чтобы передать выходные данные команды Windows PowerShell командлету. Также можно хранить данные в переменной и использовать параметр InputObject для передачи данных в командлет. Дополнительные сведения см. в примерах.
Командлет Out-Host отправляет данные, но не создает никаких объектов вывода. Если передать по конвейеру вывод командлета Out-Host командлету Get-Member, командлет Get-Member сообщит, что не указано ни одного объекта.
Пример 1
C:\PS>get-process | out-host -paging
Описание
-----------
Эта команда отображает сведения о выполняемых в системе процессах по одной странице. Для получения объектов, представляющих процессы в системе, используется команда Get-Process. Оператор конвейера (|) отправляет результаты командлету Out-Host, который выводит их на консоль. Параметр Paging указывает, что данные нужно выводить по одной странице.
Такой же формат используется при выполнении встроенной в Windows PowerShell функции Help. Эта функция получает данные, возвращенные командлетом Get-Help, после чего с помощью параметра Paging командлета Out-Host выводит их по одной странице, используя следующий формат команды: get-help $args[0] | out-host -paging).
Пример 2
C:\PS>$a = get-history
C:\PS>out-host -InputObject $a
Описание
-----------
Эти команды выводят журнал сеанса в командной строке. Первая команда получает с помощью командлета Get-History журнал сеанса и сохраняет его в переменной $a. Вторая команда отображает содержимое переменной $a с помощью командлета Out-Host, указывая на нее Out-Host с помощью параметра InputObject.
См. также
Концепции
Out-Printer
Out-Null
Out-File
Out-String
Out-Default
Write-Host