Partilhar via

Format-Custom

Módulo:
Microsoft.PowerShell.Utility Module

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

Sintaxe

Default (Predefinição) 

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. Pode utilizar as vistas definidas no formato *. Arquivos PS1XML no diretório do PowerShell ou você pode criar suas próprias exibições em novos arquivos 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 uma exibição personalizada alternativa. 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.

Propriedades dos parâmetros

Tipo:Int32
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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 a 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 de coleção.
  • Ambos: Exibe as propriedades do objeto de coleção e as propriedades dos objetos na coleção.

Propriedades dos parâmetros

Tipo:String
Default value:EnumOnly
Valores aceites:CoreOnly, EnumOnly, Both
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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. Para criar uma propriedade calculada, use uma tabela de hash. As chaves válidas são:

  • Nome (ou Rótulo) <cadeia de caracteres>
  • Expressão <cadeia de caracteres> ou <bloco de script>
  • Cadeia de caracteres FormatString <>

Propriedades dos parâmetros

Tipo:Object
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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.

Propriedades dos parâmetros

Tipo:PSObject
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:True
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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. Para criar uma propriedade calculada, use uma tabela de hash. As chaves válidas são:

  • Expressão <cadeia de caracteres> ou <bloco de script>
  • Profundidade <int32>

Propriedades dos parâmetros

Tipo:

Object[]

Default value:None
Suporta carateres universais:True
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ShowError

Envia erros através do fluxo de processamento. 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.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-View

Especifica o nome de um formato alternativo ou "exibição". 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 de propriedade e os parâmetros de visualização no mesmo comando.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PSObject

Você pode canalizar qualquer objeto para Format-Custom.

Saídas

Microsoft.PowerShell.Commands.Internal.Format

Format-Custom retorna os objetos de formato que representam a exibição.

Notas

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.

Você também pode se referir a Format-Custom por seu alias interno, "fc". Para obter mais informações, consulte about_Aliases.

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.