Format-Custom
Usa uma exibição personalizada para formatar a saída.
Sintaxe
Default (Default)
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 projetado para exibir exibições que não são apenas tabelas ou apenas listas. Você pode usar as exibições 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 exibição personalizada
Get-Command Start-Transcript | Format-Custom -View MyView
Esse comando formata informações sobre o cmdlet Start-Transcript no formato definido pelo modo de exibição MyView, uma exibição personalizada criada pelo usuário. Para executar esse comando com êxito, primeiro você deve 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 o modo de exibição padrão
Get-Process Winlogon | Format-Custom
Esse comando formata informações sobre o processo do Winlogon em uma exibição personalizada alternativa.
Como o comando não usa o parâmetro View, Format-Custom usa uma exibição personalizada 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 a 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 do parâmetro
| Tipo: | Int32 |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Expand
Formata o objeto de coleção, bem como os objetos na coleção. Esse parâmetro foi projetado para formatar objetos que dão 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.
- Ambos: exibe as propriedades do objeto de coleção e as propriedades dos objetos na coleção.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | EnumOnly |
| Valores aceitos: | CoreOnly, EnumOnly, Both |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 de exibição, apenas algumas das informações de erro são exibidas.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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>
- < > de cadeia de caracteres formatString
Propriedades do parâmetro
| Tipo: | Object |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-InputObject
Especifica os objetos a serem formatados. Insira uma variável que contenha os objetos ou digite um comando ou expressão que obtém os objetos.
Propriedades do parâmetro
| Tipo: | PSObject |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Property
Especifica as propriedades do objeto que aparecem na exibição e a ordem em que elas aparecem. Caracteres curinga são permitidos.
Se você omitir esse parâmetro, as propriedades que aparecem na exibição dependerão do objeto que está sendo exibido. O nome do parâmetro ("Propriedade") é 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:
- Expressão <cadeia de caracteres> ou <bloco de script>
- Profundidade <> int32
Propriedades do parâmetro
| Tipo: | Object[] |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-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 comando Format-Custom e as expressões não parecem estar funcionando.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-View
Especifica o nome de um formato alternativo ou "exibição". Se você omitir esse parâmetro, Format-Custom usará uma exibição personalizada padrão. Você não pode usar os parâmetros Property e View no mesmo comando.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 redirecionar qualquer objeto para Format-Custom.
Saídas
Microsoft.PowerShell.Commands.Internal.Format
Format-Custom retorna os objetos de formato que representam a exibição.
Observações
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 uma lista alternativa, 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 sejam classificados. Antes de usar Format-Custom para agrupar os objetos, use Sort-Object para classificá-los.