Out-Host
Envia a saída para a linha de comando.
Sintaxe
All
Out-Host
[-Paging]
[-InputObject <PSObject>]
[<CommonParameters>]
Description
O cmdlet Out-Host 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 deseje usar seus parâmetros.
Out-Host é acrescentado automaticamente a todos os comandos executados. Ele passa a saída do pipeline para o host executando o comando.
Out-Host ignora sequências de escape ANSI. As sequências de escape são manipuladas pelo host.
Out-Host passa sequências de escape ANSI para o host sem tentar interpretá-las ou alterá-las.
Exemplos
Exemplo 1: Exibir uma página de saída 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 pelo pipeline.
Out-Host usa o parâmetro de Paginação para exibir uma página de dados por 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 variável $io.
Out-Host usa o parâmetro InputObject para especificar a variável $io 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 obtém os objetos.
Propriedades do parâmetro
| Tipo: | PSObject |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 Espaço para exibir a próxima página de saída ou a tecla Enter para exibir a próxima linha de saída. Pressione Q para sair.
de Paginação é semelhante ao comando mais.
Observação
O parâmetro de paginação não é compatível com o host ISE do PowerShell.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
PSObject
Você pode redirecionar qualquer objeto para este cmdlet.
Saídas
None
Esse cmdlet não retorna nenhuma saída. Ele envia objetos para o host para exibição.
Observações
O PowerShell inclui os seguintes aliases para Out-Host:
- Todas as plataformas:
oh
O parâmetro de paginação não é suportado por todos os hosts do PowerShell. Por exemplo, se você usar o parâmetro de Paginação 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 formatar objetos. Eles renderizam objetos e os enviam para o destino de exibição especificado. Se você enviar um objeto não formatado para um cmdlet Out-, o cmdlet o enviará para um cmdlet de formatação antes de renderizá-lo.
Os cmdlets Out- não têm parâmetros para nomes ou caminhos de arquivo. Para enviar dados para um cmdlet Out-, 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ê pipeline a saída de Out-Host para o cmdlet Get-Member, Get-Member relata que nenhum objeto foi especificado.