Out-String
Envia objetos para o host como uma série de string.
Sintaxe
Out-String [-InputObject <psobject>] [-Stream] [-Width <int>] [<CommonParameters>]
Descrição
O cmdlet Out-String converte os objetos gerenciados pelo Windows PowerShell em uma matriz de strings. Por padrão, Out-String acumula strings e as retorna como uma única string, mas você pode usar o parâmetro Stream para direcionar Out-String, a fim de que ele retorne uma string por vez. Esse cmdlet permite que você busque e manipule a saída da string da mesma forma que faria em shells tradicionais, nos casos em que a manipulação de objetos é menos conveniente.
Parâmetros
-InputObject <psobject>
Especifica os objetos a serem gravados em uma string. Insira uma variável que contenha os objetos, ou digite um comando ou uma expressão que obtenha os objetos.
| Necessário? | false |
| Posição? | named |
| Valor padrão | |
| Aceitar entrada do pipeline? | true (ByValue) |
| Aceitar caracteres curinga? | false |
-Stream
Envia as strings para cada objeto separadamente. Por padrão, as strings para cada objeto são acumuladas e enviadas como uma única string.
| Necessário? | false |
| Posição? | named |
| Valor padrão | |
| Aceitar entrada do pipeline? | false |
| Aceitar caracteres curinga? | false |
-Width <int>
Especifica o número de caracteres em cada linha da saída. Quaisquer caracteres adicionais são truncados, não ajustados. Se você omitir esse parâmetro, a largura será determinada pelas características do host. O padrão para o host do PowerShell.exe é de 80 (caracteres).
| Necessário? | false |
| Posição? | named |
| Valor padrão | |
| Aceitar entrada do pipeline? | false |
| Aceitar caracteres curinga? | false |
<CommonParameters>
Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.
Entradas e saídas
O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.
| Entradas | System.Management.Automation.PSObject
É possível canalizar objetos para Out-String. |
| Saídas | System.String
Out-String retorna a string que cria a partir do objeto de entrada. |
Observações
Os cmdlets que contêm o verbo Out (os cmdlets Out) não formatam objetos; eles apenas os processam e os enviam ao destino de exibição especificado. Se você enviar um objeto não formatado a um cmdlet Out, o cmdlet o envia a um cmdlet de formatação antes de renderizá-lo.
Os cmdlets Out não possuem parâmetros para nomes ou caminhos de arquivo. Para enviar dados a 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 ao cmdlet. Para obter mais informações, consulte os exemplos.
Exemplo 1
C:\PS>get-content C:\test1\testfile2.txt | out-string Descrição ----------- Este comando envia o conteúdo do arquivo Testfile2.txt para o console como uma única string. 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 string.
Exemplo 2
C:\PS>$c = get-culture | select-object * C:\PS> out-string -inputobject $c -width 100 Descrição ----------- Esses comandos obtêm as configurações regionais para o usuário atual e convertem os dados em strings. O primeiro comando utiliza 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 o Get-Culture recuperou. Em seguida, o comando armazena os resultados na variável $c. O segundo comando usa Out-String para converter o objeto CultureInfo em uma série de strings (uma para cada propriedade). Ele usa o parâmetro InputObject para passar a variável $c para Out-String. O parâmetro Width é definido para 100 caracteres por linha para evitar truncamento.
Exemplo 3
C:\PS>get-alias | out-string -stream | select-string "Get-Command" Descrição ----------- Esse comando exibe os aliases que incluem a expressão "Get-Command". Ele usa o cmdlet Get-Alias para obter um conjunto de objetos AliasInfo (um para cada alias na sessão atual). O exemplo demonstra a diferença entre trabalhar com objetos e com strings. O operador de pipeline (|) envia a saída de Get-Alias para Out-String, que converte os objetos em uma série de strings. Ele usa o parâmetro Stream para enviar cada string individualmente, em vez de concatená-las em uma única string. Outro operador de pipeline envia as strings para Select-String, o qual seleciona as strings que incluem "Get-Command" em qualquer parte da cadeia. Se você omitir o parâmetro Stream, o comando exibirá todos os aliases, pois Select-String localiza "Get-Command" na única string que Out-String retorna e o formatador exibe a string como uma tabela.