Formata a saída como uma lista de propriedades na qual cada propriedade aparece em uma nova linha.
Sintaxe
Format-List [[-Property] <Object[]>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
Descrição
O cmdlet Format-List formata a saída de um comando como uma lista de propriedades na qual cada propriedade é exibida em uma linha separada. Você pode usar o Format-List para formatar e exibir todas ou as propriedades selecionadas de um objeto como uma lista (format-list *).
Como mais espaço está disponível para cada item em uma lista do que em uma tabela, o Windows PowerShell exibe mais propriedades do objeto na lista; portanto, há menor probabilidade de que os valores da propriedade sejam truncados.
Parâmetros
-DisplayError
Exibe erros na linha de comando.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Expand <string>
Formata o objeto da coleção, bem como os objetos na coleção. Este parâmetro foi desenvolvido para formatar objetos que ofereçam suporte à interface ICollection (System.Collections). O valor padrão é EnumOnly.
Os valores válidos são:
-- EnumOnly: exibe as propriedades dos objetos na coleção.
-- CoreOnly: exibe as propriedades do objeto da coleção.
-- Both: exibe as propriedades do objeto da coleção, bem como dos objetos na coleção.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-Force
Direciona o cmdlet para exibir todas as informações de erro. Use com os parâmetros DisplayError ou ShowError. Por padrão, quando um objeto de erro é gravado nos fluxos de erro ou exibição, somente algumas das informações de erro são exibidas.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-GroupBy <Object>
Formata a saída em grupos com base em uma propriedade ou valor compartilhado. Digite uma expressão ou uma propriedade da saída.
O valor do parâmetro GroupBy pode ser uma nova propriedade calculada. Para criar uma propriedade calculada, use uma tabela de hash. As chaves válidas são:
-- Name (ou Label) <cadeia de caracteres>
-- Expression <cadeia de caracteres> ou <bloco de script>
-- FormatString <cadeia de caracteres>
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-InputObject <psobject>
Especifica os objetos a serem formatados. Insira uma variável que contenha os objetos ou digite um comando ou 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 |
-Property <Object[]>
Especifica as propriedades do objeto que aparecem na exibição e a ordem na qual são exibidas. Os caracteres curinga são permitidos.
Se você omitir esse parâmetro, as propriedades que aparecem na exibição dependerão do objeto sendo exibido. O nome do parâmetro ("Property") é opcional. Você não pode usar os parâmetros Property e View no mesmo comando.
O valor do parâmetro Property pode ser uma nova propriedade calculada. Para criar uma propriedade calculada, use uma tabela de hash. As chaves válidas são:
-- Name (ou Label) <cadeia de caracteres>
-- Expression <cadeia de caracteres> ou <bloco de script>
-- FormatString <cadeia de caracteres>
|
Necessário? |
false |
|
Posição? |
1 |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-ShowError
Envia erros pelo pipeline.
|
Necessário? |
false |
|
Posição? |
named |
|
Valor padrão |
|
|
Aceitar entrada do pipeline? |
false |
|
Aceitar caracteres curinga? |
false |
-View <string>
Especifica o nome de um formato de lista ou "exibição" alternativa. Você não pode usar os parâmetros Property e View no mesmo comando.
|
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 Você pode canalizar qualquer objeto para Format-List. |
|
Saídas |
Microsoft.PowerShell.Commands.Internal.Format Format-List retorna os objetos de formato que representa a lista. |
Observações
Você também pode se referir a Format-List usando seu alias interno, "FL". Para obter mais informações, consulte about_Aliases.
Os cmdlets de formato, como Format-List, distribuem os dados para que sejam exibidos, mas não os exibem. Os dados são exibidos pelos recursos de saída do Windows PowerShell e pelos cmdlets que contêm o verbo Out (os cmdlets Out), como Out-Host, Out-File e Out-Printer.
Se você não utilizar um cmdlet de formato, o Windows PowerShell aplicará o formato padrão a cada objeto que exibir.
O parâmetro GroupBy supõe que os objetos estão classificados. Antes de usar Format-Custom para agrupar os objetos, use Sort-Object para classificá-los.
O parâmetro View permite que você especifique um formato alternativo para a tabela. Você pode usar as exibições definidas nos arquivos *.format.PS1XML no diretório do Windows PowerShell ou criar suas próprias exibições em novos arquivos PS1XML e usar o cmdlet Update-FormatData para incluí-las no Windows PowerShell.
A exibição alternativa do parâmetro View deverá usar o formato de lista; caso contrário, o comando falhará. Se a exibição alternativa for uma tabela, use Format-Table. Se a exibição alternativa não for uma lista nem uma tabela, use Format-Custom.
Exemplo 1
C:\PS>get-service | format-list Descrição ----------- Este comando formata as informações sobre os serviços do computador como uma lista. Por padrão, os serviços são formatados como uma tabela. O cmdlet Get-Service obtém os objetos que representam os serviços no computador. O operador de pipeline (|) passa os resultados pelo pipeline para Format-List. Em seguida, o comando Format-List formata as informações de serviço em uma lista e as envia ao cmdlet de saída padrão para exibição.
Exemplo 2
C:\PS>$a = get-childitem $pshome\*.ps1xml Descrição ----------- Esses comandos exibem informações sobre os arquivos PS1XML no diretório do Windows PowerShell como uma lista. O primeiro comando obtém os objetos representando os arquivos e os armazena na variável $a. O segundo comando usa Format-List para formatar as informações sobre os objetos armazenados em $a. Esse comando usa o parâmetro InputObject para passar a variável para Format-List, que envia a saída formatada ao cmdlet de saída padrão para exibição.
Exemplo 3
C:\PS>get-process | format-list -property name, basepriority, priorityclass Descrição ----------- Este comando exibe o nome, a prioridade básica e a classe de prioridade de cada processo no computador. Ele usa o cmdlet Get-Process para obter um objeto que representa cada processo. O operador de pipeline (|) passa os objetos do processo pelo pipeline para Format-List. Format-List formata os processos como uma lista das propriedades especificadas. O nome do parâmetro "Property" é opcional; portanto, você pode omiti-lo.
Exemplo 4
C:\PS>get-process winlogon | format-list -property * Descrição ----------- Este comando exibe todas as propriedades do processo Winlogon. Ele usa o cmdlet Get-Process para obter um objeto que representa o processo Winlogon. O operador de pipeline (|) passa o objeto do processo Winlogon pelo pipeline para Format-List. O comando usa o parâmetro Property para especificar as propriedades e * para indicar todas elas. Como o nome do parâmetro Property é opcional, você pode omiti-lo e pode digitar o comando como: "format-list * ". Format-List envia os resultados automaticamente ao cmdlet de saída padrão para exibição.