Partilhar via

Format-Custom

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

Usa um modo de exibição personalizado para formatar a saída.

Sintaxe

Format-Custom
      [[-Property] <Object[]>]
      [-Depth <Int32>]
      [-GroupBy <Object>]
      [-View <String>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <String>]
      [-InputObject <PSObject>]
      [<CommonParameters>]

Description

O cmdlet Format-Custom formata a saída de um comando conforme definido em uma exibição alternativa. Format-Custom foi concebido para apresentar vistas que não são apenas tabelas ou apenas listas. Você pode usar os modos de exibição definidos no PowerShell ou pode criar seus próprios modos de exibição em um novo arquivo de format.ps1xml e usar o cmdlet Update-FormatData para adicioná-los ao PowerShell.

Exemplos

Exemplo 1: Formatar saída com uma vista personalizada

Get-Command Start-Transcript | Format-Custom -View MyView

Este comando formata informações sobre o cmdlet Start-Transcript no formato definido pela visualização MyView, uma exibição personalizada criada pelo usuário. Para executar esse comando com êxito, você deve primeiro criar um novo arquivo PS1XML, definir o modo de exibição MyView e, em seguida, usar o comando Update-FormatData para adicionar o arquivo PS1XML ao PowerShell.

Exemplo 2: Formatar saída com a vista predefinida

Get-Process Winlogon | Format-Custom

Este comando formata informações sobre o processo Winlogon em um modo de exibição personalizado alternativo. Como o comando não usa o parâmetro View, Format-Custom usa um modo de exibição personalizado padrão para formatar os dados.

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.

PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -DisplayError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  = #ERR
}


PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  =
}

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

Parâmetros

-Depth

Especifica o número de colunas na exibição.

Tipo:Int32
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DisplayError

Exibe 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 comando Format-Custom e as expressões não parecem estar funcionando.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Expand

Formata o objeto de coleção, bem como os objetos na coleção. Este parâmetro foi projetado para formatar objetos que suportam o System.Collections.ICollection interface. 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.
  • Ambos: Exibe as propriedades do objeto de coleção e os objetos na coleção.
Tipo:String
Valores aceites:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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, apenas algumas das informações de erro são exibidas.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 parâmetro GroupBy espera que os objetos sejam classificados. Use o cmdlet Sort-Object antes de usáFormat-Custom para agrupar os objetos.

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 chave-valor válidos são:

  • Nome (ou rótulo) - <string>
  • Expressão - <string> ou <script block>
  • FormatString - <string>

Para obter mais informações, consulte about_Calculated_Properties.

Tipo:Object
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InputObject

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.

Tipo:PSObject
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Property

Especifica as propriedades do objeto que aparecem na exibição e a ordem em que aparecem. Curingas são permitidos.

Se você omitir esse parâmetro, as propriedades que aparecem na exibição dependem do objeto que está sendo exibido. O nome do parâmetro Property é opcional. Não é possível usar os parâmetros de propriedade e os parâmetros de 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 chave-valor válidos são:

  • Expressão - <string> ou <script block>
  • Profundidade - <int32>

Para obter mais informações, consulte about_Calculated_Properties.

Tipo:Object[]
Position:0
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

-ShowError

Envia erros através 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 comando Format-Custom e as expressões não parecem estar funcionando.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-View

Especifica o nome de um formato ou modo de exibição alternativo. Se você omitir esse parâmetro, Format-Custom usará um modo de exibição personalizado padrão. Não pode usar os parâmetros de Propriedade e de Vista no mesmo comando.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

PSObject

Você pode canalizar qualquer objeto para este cmdlet.

Saídas

Microsoft.PowerShell.Commands.Internal.Format

Este cmdlet retorna os objetos de formato que representam a exibição.

Notas

O PowerShell inclui os seguintes aliases para Format-Custom:

  • Todas as plataformas:
    • fc

Format-Custom foi concebido para apresentar vistas que não são apenas tabelas ou apenas listas. Para exibir um modo de exibição de tabela alternativo, use Format-Table. Para exibir um modo de exibição de lista alternativo, use Format-List.

O parâmetro GroupBy pressupõe que os objetos estão classificados. Antes de usar Format-Custom para agrupar os objetos, use Sort-Object para classificá-los.