Compartilhar via

Out-String

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

Envia objetos para o host como uma série de cadeias de caracteres.

Sintaxe

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

Description

O cmdlet Out-String converte os objetos que o Windows PowerShell gerencia 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 que você pesquise e manipule a saída da cadeia de caracteres como faria em shells tradicionais quando a manipulação de objeto é menos conveniente.

Exemplos

Exemplo 1: Texto de saída para o console como uma cadeia de caracteres

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

Esse 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.

Exemplo 2: Obter a cultura atual e converter os dados em cadeias 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 para . 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 do usuário atual e convertem os dados em cadeias de caracteres.

Exemplo 3: Trabalhando com objetos

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 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 cadeia de caracteres individualmente, em vez de concatená-las em uma única cadeia de caracteres. 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, pois Select-String localiza "Get-Command" na única cadeia de caracteres que Out-String retorna e o formatador exibe a cadeia de caracteres como uma tabela.

Parâmetros

-InputObject

Especifica os objetos a serem gravados em uma cadeia de caracteres. Insira uma variável que contenha os objetos ou digite um comando ou expressão que obtém os objetos.

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

-Stream

Indica que o cmdlet envia as cadeias de caracteres para cada objeto separadamente. Por padrão, as cadeias de caracteres para cada objeto são acumuladas e enviadas como uma única cadeia de caracteres.

Para usar o parâmetro Stream, digite -Stream ou seu alias, ost.

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

-Width

Especifica o número de caracteres em cada linha de saída. Quaisquer caracteres adicionais são truncados, não encapsulados. O parâmetro Width aplica-se somente a objetos que estão sendo formatados. Se você omitir esse parâmetro, a largura será determinada pelas características do programa host. O valor padrão para o console do Windows PowerShell é 80 (caracteres).

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

Entradas

PSObject

Você pode redirecionar objetos para Out-String.

Saídas

String

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

Observações

  • Os cmdlets que contêm o verbo Out que não formatar objetos; eles simplesmente os renderizam 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 que levam 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.