Utiliza uma exibição personalizada para formatar a saída.

Sintaxe

Format-Custom [[-Property] <Object[]>] [-Depth <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]

Descrição

O cmdlet Format-Custom formata a saída de um comando conforme definido em uma exibição alternativa. Format-Custom foi desenvolvido para mostrar exibições que não sejam somente tabelas ou listas. Você pode usar as exibições definidas nos arquivos *format.PS1XML no diretório do Windows PowerShell ou criar suas próprias exibições em novos arquivos PS1XML e usar o cmdlet Update-FormatData para acrescentá-las ao Windows PowerShell.

Parâmetros

-Depth <int>

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

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-DisplayError

Exibe erros na linha de comando.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-Expand <string>

Formata o objeto da coleção, bem como os objetos na coleção. Este parâmetro foi desenvolvido para formatar objetos que ofereçam 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.

-- Both: exibe as propriedades do objeto da coleção, bem como dos objetos na coleção.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

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, somente algumas das informações de erro são exibidas.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-GroupBy <Object>

Formata a saída em grupos com base em uma propriedade ou valor compartilhado. Digite 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:

-- Name (ou Label) <cadeia de caracteres>

-- Expression <cadeia de caracteres> ou <bloco de script>

-- FormatString <cadeia de caracteres>

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-InputObject <psobject>

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.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

true (ByValue)

Aceitar caracteres curinga?

false

-Property <Object[]>

Especifica as propriedades do objeto que aparecem na exibição e a ordem na qual são exibidas. Os caracteres curinga são permitidos.

Se você omitir esse parâmetro, as propriedades que aparecem na exibição dependerão do objeto sendo exibido. O nome do parâmetro ("Property") é 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:

-- Expression <cadeia de caracteres> ou <bloco de script>

-- Depth <int32>

Necessário?

false

Posição?

1

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-ShowError

Envia erros pelo pipeline.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

-View <string>

Especifica o nome de um formato ou "exibição" alternativa. Se você omitir esse parâmetro, o Format-Custom usará uma exibição personalizada padrão. Você não pode usar os parâmetros Property e View no mesmo comando.

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas

System.Management.Automation.PSObject

Você pode canalizar qualquer objeto para Format-Custom

Saídas

Microsoft.PowerShell.Commands.Internal.Format

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

Observações

O Format-Custom foi desenvolvido para mostrar exibições que não sejam somente tabelas ou listas. Para mostrar uma exibição alternativa de tabela, use Format-Table. Para mostrar uma exibição alternativa de lista, use Format-List.

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

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

Exemplo 1

C:\PS>get-command start-transcript | format-custom -view MyView

Descrição
-----------
Esse comando formata as informações sobre o cmdlet Start-Transcript no formato definido pela exibição MyView, uma exibição personalizada criada pelo usuário. Para executar esse comando com êxito, você precisa primeiro criar um novo arquivo PS1XML, definir a exibição MyView e usar o comando Update-FormatData para acrescentar o arquivo PS1XML ao Windows PowerShell.

Exemplo 2

C:\PS>get-process Winlogon | format-custom

Descrição
-----------
Este comando formata as 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 uma exibição personalizada padrão para formatar os dados.



Sumário