Out-String

Out-String
    [-Stream]
    [-Width <Int32>]
    [-InputObject <PSObject>]
    [<CommonParameters>]

O cmdlet Out-String converte os objetos gerenciados pelo Windows PowerShell em uma matriz de cadeias de caracteres. Por padrão, Out-String acumula as cadeias de caracteres e as retorna como uma única cadeia de caracteres, mas você pode usar o parâmetro Stream para direcionar Out-String para retornar uma cadeia de caracteres de cada vez. Esse cmdlet permite pesquisar e manipular a saída de cadeia de caracteres como faria em shells tradicionais quando a manipulação de objetos é menos conveniente.

PS C:\> Get-Content C:\test1\testfile2.txt | Out-String

Este comando envia o conteúdo do arquivo Testfile2.txt para o console como uma única cadeia de caracteres. Ele usa o cmdlet Get-Content para obter o conteúdo do arquivo. O operador de pipeline (|) envia o conteúdo para Out-String, que envia o conteúdo para o console como uma cadeia de caracteres.

O primeiro comando usa o cmdlet Get-Culture para obter as configurações regionais. O operador de pipeline (|) envia o resultado para o cmdlet Select-Object, que seleciona todas as propriedades (*) do objeto de cultura que Get-Culture retornado. Em seguida, o comando armazena os resultados na variável $C.

O segundo comando usa o cmdlet Out-String para converter o objeto CultureInfo em uma série de cadeias de caracteres (uma cadeia de caracteres para cada propriedade). Ele usa o parâmetro InputObject para passar a variável $C para Out-String. O parâmetro Width é definido como 100 caracteres por linha para evitar truncamento.

PS C:\> $C = Get-Culture | Select-Object *
PS C:\> Out-String -InputObject $C -Width 100

Esses comandos obtêm as configurações regionais para o usuário atual e convertem os dados em cadeias de caracteres.

PS C:\> Get-Alias | Out-String -Stream | Select-String "Get-Command"

Este exemplo demonstra a diferença entre trabalhar com objetos e trabalhar com cadeias de caracteres. O comando exibe aliases que incluem a frase "Get-Command". Ele usa o cmdlet Get-Alias para obter um conjunto de objetos AliasInfo (um para cada alias na sessão atual).

O operador de pipeline (|) envia a saída do cmdlet Get-Alias para o cmdlet Out-String, que converte os objetos em uma série de cadeias de caracteres. Ele usa o parâmetro Stream de Out-String para enviar cada string individualmente, em vez de concatená-las em uma única string. Outro operador de pipeline envia as cadeias de caracteres para o cmdlet Select-String, que seleciona as cadeias de caracteres que incluem "Get-Command" em qualquer lugar da cadeia de caracteres.

Se você omitir o parâmetro Stream, o comando exibirá todos os aliases, porque Select-String encontra "Get-Command" na única cadeia de caracteres que Out-String retorna e o formatador exibe a cadeia de caracteres como uma tabela.

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.

Você pode canalizar objetos para Out-String.

Out-String retorna a cadeia de caracteres que ele cria a partir do objeto de entrada.

• Os cmdlets que contêm o verbo out que não formatam objetos; eles apenas os renderizam e 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 que usam nomes ou caminhos de arquivo. Para enviar dados para 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 para o cmdlet.