Envia a saída para a linha de comando.
Sintaxe
Out-Host [-InputObject <psobject>] [-Paging] [<CommonParameters>]
Descrição
O cmdlet Out-Host envia a saída para o host do Windows PowerShell para fins de exibição. O host exibe a saída na linha de comando. Como o Out-Host é o padrão, você não precisa especificá-lo, a menos que queira utilizar seus parâmetros para alterar a exibição.
Parâmetros
-InputObject <psobject>
Especifica os objetos a serem gravados no console. Insira uma variável que contenha os objetos, ou digite um comando ou uma expressão que obtenha os objetos.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
true (ByValue) |
|
Aceitar caracteres curinga? |
false |
-Paging
Exibe uma página de saída por vez e aguarda a entrada do usuário antes de exibir as páginas restantes, de forma muito parecida com o tradicional comando "more". Por padrão, todas as saídas são exibidas em uma única página. O tamanho da página é determinado pelas características do host.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
|
Entradas |
System.Management.Automation.PSObject Você pode canalizar qualquer objeto para Out-Host. |
|
Saídas |
None Out-Host não gera saída. Porém, o host poderia exibir os objetos que Out-Host envia para ele. |
Observações
Você também pode fazer referência a Out-Host usando seu alias interno, "oh". Para obter mais informações, consulte about_Aliases.
Os cmdlets que contêm o verbo Out (os cmdlets Out) não formatam objetos; eles apenas os processam e os enviam ao destino de exibição especificado. Se você enviar um objeto não formatado a um cmdlet Out, o cmdlet o envia a um cmdlet de formatação antes de renderizá-lo.
Os cmdlets Out não possuem parâmetros para nomes ou caminhos de arquivo. Para enviar dados a um cmdlet Out, use um operador de pipeline (|) para enviar a saída de um comando do Windows PowerShell para o cmdlet. Você também pode armazenar dados em uma variável e usar o parâmetro InputObject para passar os dados ao cmdlet. Para obter ajuda, consulte os exemplos.
Out-Host envia dados, mas não emite qualquer objeto de saída. Se você canalizar a saída de Out-Host para Get-Member, Get-Member relatará que nenhum objeto foi especificado.
Exemplo 1
C:\PS>get-process | out-host -paging Descrição ----------- Este comando exibe os processos no sistema em uma página de cada vez. Ele usa o comando Get-Process para obter todos os processos no sistema. O operador de pipeline (|) envia os resultados para Out-Host, que os exibe no console. O parâmetro Paging exibe uma página de dados por vez. O mesmo formato de comando é usado para a função Help interna do Windows PowerShell. Essa função obtém dados de Get-Help e usa o parâmetro Paging de Out-Host para exibir os dados em uma página de cada vez usando este formato de comando: get-help $args[0] | out-host -paging).
Exemplo 2
C:\PS>$a = get-history C:\PS>out-host -InputObject $a Descrição ----------- Esses comandos exibem o histórico da sessão na linha de comando. O primeiro comando usa o cmdlet Get-History para obter o histórico da sessão e, em seguida, armazena-o na variável $a. O segundo comando usa Out-Host para exibir o conteúdo da variável $a e usa o parâmetro InputObject para especificar a variável para Out-Host.
See Also