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 queira usar seus parâmetros.
Out-Host 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 pelo 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 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 obtenha os objetos.
Propriedades dos parâmetros
| Tipo: | PSObject |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Paging
Indica que Out-Host exibe uma página de saída de cada vez. O tamanho da página é determinado pelas características do host.
Depois de sair da primeira página, o comando aguarda a entrada do usuário antes que as páginas restantes sejam exibidas. 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.
Usar a paginação é semelhante ao uso do comando more .
Observação
O parâmetro Paging não é suportado pelo host ISE do PowerShell.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 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
Nem todos os hosts do PowerShell oferecem suporte ao parâmetro Paging . Por exemplo, se você usar o parâmetro Paging no ISE do Windows PowerShell, o seguinte erro será exibido:
out-lineoutput : O método ou operação não é implementado.
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 cmdlet Out-, o cmdlet o enviará para um cmdlet de formatação antes de renderizá-lo.
Os Out- cmdlets não leem entradas de arquivos. Para enviar dados para um Out- cmdlet, use o pipeline para enviar dados 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 apenas para o host. Tt não produz objetos de saída para o pipeline. Se você canalizar a saída de Out-Host para o cmdlet Get-Member, Get-Member informará que nenhum objeto foi especificado.
