Write-Output

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

Grava os objetos especificados no pipeline.

Sintaxe

Write-Output
     [-InputObject] <PSObject[]>
     [-NoEnumerate]
     [<CommonParameters>]

Description

Grava os objetos especificados no pipeline. Se Write-Output for o último comando no pipeline, os objetos serão exibidos no console.

Write-OutputEnvia objetos para o pipeline primário, também conhecido como fluxo de sucesso. Para enviar objetos de erro para o fluxo de erros, use Write-Error.

Esse cmdlet é usado normalmente em scripts para exibir cadeias de caracteres e outros objetos no console. Um dos aliases integrados para Write-Output é echo e semelhante a outros shells que usam echo. O comportamento padrão é exibir a saída no final de um pipeline. No PowerShell, geralmente não é necessário usar o cmdlet em instâncias em que a saída é exibida por padrão. Por exemplo, Get-Process | Write-Output é equivalente a Get-Process. Ou, echo "Home directory: $HOME" pode ser escrito, "Home directory: $HOME".

Por padrão, Write-Output enumera objetos em uma coleção. No entanto, Write-Output também pode passar coleções pelo pipeline como um único objeto com o parâmetro NoEnumerate .

Exemplos

Exemplo 1: Obter objetos e gravá-los no console

Neste exemplo, os Get-Process resultados do cmdlet são armazenados na $P variável. O Write-Output cmdlet exibe os objetos de processo no $P console.

$P = Get-Process
Write-Output $P

Exemplo 2: Passar a saída para outro cmdlet

Esse comando canaliza a cadeia de caracteres de "saída de teste" para o Get-Member cmdlet, que exibe os membros da classe System.String , demonstrando que a cadeia de caracteres foi passada ao longo do pipeline.

Write-Output "test output" | Get-Member

Exemplo 3: suprimir enumeração na saída

Esse comando adiciona o parâmetro NoEnumerate para tratar uma coleção ou matriz como um único objeto por meio do pipeline.

Write-Output 1,2,3 | Measure-Object

Count    : 3
...

Write-Output 1,2,3 -NoEnumerate | Measure-Object

Count    : 1
...

Parâmetros

-InputObject

Especifica os objetos para envio pelo pipeline. Insira uma variável que contém os objetos ou digite um comando ou uma expressão que obtém os objetos.

Tipo:PSObject[]
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-NoEnumerate

Por padrão, o Write-Output cmdlet sempre enumera sua saída. O parâmetro NoEnumerate suprime o comportamento padrão e impede Write-Output a enumeração da saída. O parâmetro NoEnumerate não terá efeito se o comando estiver entre parênteses, pois os parênteses forçam a enumeração. Por exemplo, (Write-Output 1,2,3) ainda enumera a matriz.

O parâmetro NoEnumerate só é útil em um pipeline. Tentar ver os efeitos de NoEnumerate no console é problemático porque o PowerShell adiciona Out-Default ao final de cada linha de comando, o que resulta em enumeração. Mas se você canalizar Write-Output -NoEnumerate para outro cmdlet, o cmdlet downstream receberá o objeto de coleção, não os itens enumerados da coleção.

Importante

Há um problema com essa opção no Windows PowerShell que foi corrigido no PowerShell 6.2 e superior. Ao usar NoEnumerate e usar explicitamente o parâmetro InputObject , o comando ainda enumera. Para contornar isso, passe o (s) argumento(s) InputObject posicionalmente.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

PSObject

Você pode canalizar objetos para esse cmdlet.

Saídas

PSObject

Esse cmdlet retorna os objetos que são enviados como entrada.

Observações

O Windows PowerShell inclui os seguintes aliases para Write-Output:

  • echo
  • write