Out-Host

  • Referência
Módulo:
Microsoft.PowerShell.Core

Envia a saída para a linha de comando.

Syntax

Out-Host
   [-Paging]
   [-InputObject <PSObject>]
   [<CommonParameters>]

Description

O Out-Host cmdlet envia a saída para o host do PowerShell para exibição. O host exibe a saída na linha de comando. Como Out-Host é o padrão, você não precisa especificá-lo, a menos que queira usar seus parâmetros.

Out-Host é automaticamente anexado a cada comando executado. Ele passa a saída do pipeline para o host que executa o comando. Out-Host ignora as sequências de escape ANSI. As sequências de escape são tratadas pelo anfitrião. Out-Host passa sequências de escape ANSI para o host sem tentar interpretá-las ou alterá-las.

Exemplos

Exemplo 1: Exibir a saída uma página de cada vez

Este exemplo exibe os processos do sistema uma página de cada vez.

Get-Process | Out-Host -Paging

NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
     30    24.12      36.95      15.86   21004  14 ApplicationFrameHost
     55    24.33      60.48      10.80   12904  14 BCompare
<SPACE> next page; <CR> next line; Q quit
      9     4.71       8.94       0.00   16864  14 explorer
<SPACE> next page; <CR> next line; Q quit

Get-Process Obtém os processos do sistema e envia os objetos para o pipeline. Out-Host usa o parâmetro Paging para exibir uma página de dados de cada vez.

Exemplo 2: Usar uma variável como entrada

Este exemplo usa objetos armazenados em uma variável como a entrada para Out-Host.

$io = Get-History
Out-Host -InputObject $io

Get-History obtém o histórico da sessão do PowerShell e armazena os objetos na $io variável. Out-Host usa o parâmetro InputObject para especificar a $io variável e exibe o histórico.

Parâmetros

-InputObject

Especifica os objetos que são gravados no console. Insira uma variável que contenha os objetos ou digite um comando ou expressão que obtenha os objetos.

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

-Paging

Indica que Out-Host exibe uma página de saída de cada vez e aguarda a entrada do usuário antes que as páginas restantes sejam exibidas. Por padrão, toda a saída é exibida em uma única página. O tamanho da página é determinado pelas características do host.

Pressione a barra de espaço para exibir a próxima página de saída ou a tecla Enter para visualizar a próxima linha de saída. Pressione Q para sair.

A paginação é semelhante ao comando mais .

Nota

O parâmetro Paging não é suportado pelo host ISE do PowerShell.

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

Entradas

PSObject

Você pode canalizar qualquer objeto para este cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída. Ele envia objetos para o host para exibição.

Notas

O PowerShell inclui os seguintes aliases para Out-Host:

  • Todas as plataformas:
    • oh

O parâmetro Paging não é suportado por todos os hosts do PowerShell. Por exemplo, se você usar o parâmetro Paging no ISE do PowerShell, o seguinte erro será exibido: out-lineoutput : The method or operation is not implemented.

Os cmdlets que contêm o verbo out , Out-, não formatam objetos. Eles renderizam objetos e os enviam para o destino de exibição especificado. Se você enviar um objeto não formatado para um Out- cmdlet, o cmdlet o enviará para um cmdlet de formatação antes de renderizá-lo.

Os Out- cmdlets não têm parâmetros para nomes ou caminhos de arquivo. Para enviar dados para um Out- cmdlet, use o pipeline para enviar a saída de um comando do PowerShell para o cmdlet. Ou, você pode armazenar dados em uma variável e usar o parâmetro InputObject para passar os dados para o cmdlet.

Out-Host envia dados, mas não produz nenhum objeto de saída. Se você canalizar a saída para Out-Host o Get-Member cmdlet, Get-Member informará que nenhum objeto foi especificado.