Format-Custom

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

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

Syntax

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

Description

O Format-Custom cmdlet formata a saída de um comando conforme definido em um modo de exibição alternativo. Format-Custom foi projetado para exibir exibições 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 format.ps1xml arquivo e usar o Update-FormatData cmdlet para adicioná-los ao PowerShell.

Exemplos

Exemplo 1: Formatar saída com um modo de exibição personalizado

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

Esse comando formata informações sobre o Start-Transcript cmdlet no formato definido pelo modo de exibição MyView, um modo de exibição personalizado criado 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 Update-FormatData comando para adicionar o arquivo PS1XML ao PowerShell.

Exemplo 2: Formatar saída com o modo de exibição padrão

Get-Process Winlogon | Format-Custom

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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ê estiver formatando expressões em um Format-Custom comando e as expressões não parecem estar funcionando.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 oferecem 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.
  • Ambos: Exibe as propriedades do objeto de coleção e os objetos na coleção.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Faz com que o cmdlet exiba todas as informações de erro. Use com os parâmetros DisplayError ou ShowError . Por padrão, quando um objeto de erro é gravado para os fluxos de erro ou de exibição, apenas algumas das informações de erro são exibidas.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 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.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Property

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

Se você omitir esse parâmetro, as propriedades a serem exibidas dependerão do objeto sendo exibido. A propriedade do nome do parâmetro é opcional. Não é possível usar os parâmetros Property e View 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.

Type:Object[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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ê estiver formatando expressões em um Format-Custom comando e as expressões não parecem estar funcionando.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 é possível usar os parâmetros Property e View no mesmo comando.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PSObject

Você pode canalizar qualquer objeto para esse cmdlet.

Saídas

Microsoft.PowerShell.Commands.Internal.Format

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

Observações

O Windows PowerShell inclui os seguintes aliases para Format-Custom:

  • fc

Format-Custom foi projetado para exibir exibições 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 são classificados. Antes de usar Format-Custom para agrupar os objetos, use Sort-Object para classificá-los.