Format-Wide

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

Formata objetos como uma tabela ampla que exibe apenas uma propriedade de cada objeto.

Sintaxe

Format-Wide
      [[-Property] <Object>]
      [-AutoSize]
      [-Column <int>]
      [-GroupBy <Object>]
      [-View <string>]
       [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <string>]
      [-InputObject <psobject>] 
      [<CommonParameters>]

Description

O Format-Wide cmdlet formata objetos como uma tabela larga que exibe apenas uma propriedade de cada objeto. Você pode usar o parâmetro Property para determinar qual propriedade é exibida.

Exemplos

Exemplo 1: Nomes de formato de arquivos no diretório atual

Esse comando exibe os nomes dos arquivos no diretório atual em três colunas na tela.

Get-ChildItem | Format-Wide -Column 3

O Get-ChildItem cmdlet obtém objetos que representam cada arquivo no diretório. O operador de pipeline (|) passa os objetos de arquivo pelo pipeline para Format-Wide, que os formata para saída. O parâmetro Column especifica o número de colunas.

Exemplo 2: Formatar nomes de chaves do Registro

Esse comando exibe os nomes das chaves do Registro na HKEY_CURRENT_USER\Software\Microsoft chave.

Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize

O Get-ChildItem cmdlet obtém objetos que representam as chaves. O caminho é especificado como HKCU:, uma das unidades expostas pelo provedor do Registro do PowerShell, seguido pelo caminho da chave. O operador de pipeline (|) passa os objetos de chave do Registro pelo pipeline para Format-Wide, que os formata para saída. O parâmetro Property especifica o nome da propriedade e o parâmetro AutoSize ajusta as colunas para facilitar a leitura.

Exemplo 3: Solução de problemas de erros de formato

Os exemplos a seguir mostram os resultados da adição dos parâmetros DisplayError ou ShowError com uma expressão.

PS /> Get-Date | Format-Wide { $_ / $null } -DisplayError


#ERR

PS /> Get-Date | Format-Wide { $_ / $null } -ShowError


Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 8:18:01 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Parâmetros

-AutoSize

Ajusta o tamanho da coluna e o número de colunas com base na largura dos dados. Por padrão, o número de colunas e seu tamanho são determinados pelo modo de exibição. Você não pode usar os parâmetros AutoSize e Column no mesmo comando.

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

-Column

Especifica o número de colunas a exibir. Você não pode usar os parâmetros AutoSize e Column no mesmo comando.

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

-DisplayError

Exibe eventuais erros na linha de comando. Esse parâmetro raramente é usado, mas pode ser usado como um auxílio de depuração quando você está formatando expressões em um Format-Wide comando e as expressões não parecem estar funcionando.

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

-Expand

Formata o objeto da coleção, bem como os objetos presentes na coleção. Esse parâmetro foi projetado para formatar objetos que dão suporte à interface System.Collections.ICollection . 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 de coleção.
  • Both: Exibe as propriedades do objeto de coleção e as propriedades dos objetos na coleção.
Tipo:String
Valores aceitos:CoreOnly, EnumOnly, Both
Cargo:Named
Valor padrão:EnumOnly
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

Indica que esse cmdlet substitui as restrições que impedem que o comando seja bem-sucedido, apenas para que as alterações não comprometam a segurança. Por exemplo, o Force substituirá o atributo somente leitura ou criará diretórios para concluir um caminho de arquivo, mas não tentará alterar as permissões de arquivo.

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

-GroupBy

Formata a saída em grupos com base em uma propriedade ou valor compartilhado. Insira uma expressão ou uma propriedade da saída.

O valor do parâmetro GroupBy pode ser uma nova propriedade calculada. A propriedade calculada pode ser um bloco de script ou uma tabela de hash. Os pares de chave-valor válidos são:

  • Name (ou Label) - <string>
  • Expression - <string> ou <script block>
  • FormatString - <string>

Para obter mais informações, consulte about_Calculated_Properties.

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

-InputObject

Especifica os objetos a serem formatados. 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:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Property

Especifica a propriedade do objeto que aparece na exibição. Caracteres curinga são permitidos.

Se você omitir esse parâmetro, as propriedades a serem exibidas dependerão do objeto sendo exibido. O nome do parâmetro Property é opcional. Não é possível usar os parâmetros Propriedade e Visualização no mesmo comando.

O valor do parâmetro Property pode ser uma nova propriedade calculada. A propriedade calculada pode ser um bloco de script ou uma tabela de hash. Os pares de chave-valor válidos são:

  • Expression - <string> ou <script block>
  • FormatString - <string>

Para obter mais informações, consulte about_Calculated_Properties.

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

-ShowError

Envia erros por meio do pipeline. Esse parâmetro raramente é usado, mas pode ser usado como um auxílio de depuração quando você está formatando expressões em um Format-Wide comando e as expressões não parecem estar funcionando.

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

-View

Especifica o nome de um formato de tabela ou exibição alternativa. Não é possível usar os parâmetros Propriedade e Visualização no mesmo comando.

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

Entradas

PSObject

Você pode canalizar qualquer objeto para esse cmdlet.

Saídas

Microsoft.PowerShell.Commands.Internal.Format

Esse cmdlet retorna objetos de formato que representam a tabela.

Observações

O PowerShell inclui os seguintes aliases para Format-Wide:

  • Todas as plataformas:
    • fw

O parâmetro GroupBy pressupõe que os objetos sejam classificados. Use Sort-Object antes de usar Format-Custom para agrupar os objetos.

O parâmetro View permite especificar um formato alternativo para a tabela. Você pode usar as exibições definidas nos *.format.PS1XML arquivos no diretório do PowerShell ou pode criar suas próprias exibições em novos arquivos PS1XML e usar o Update-FormatData cmdlet para incluí-las no PowerShell.

A visualização alternativa para o parâmetro View deve usar o formato de tabela; se isso não acontecer, o comando falhará. Se a exibição alternativa for uma lista, use Format-List. Se a visualização alternativa não for uma lista nem uma tabela, use Format-Custom.