Format-Custom

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Utiliza una vista personalizada para dar formato al resultado.

Syntax

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

Description

El Format-Custom cmdlet da formato a la salida de un comando tal como se define en una vista alternativa. Format-Custom está diseñado para mostrar vistas que no son solo tablas o listas. Puede usar las vistas definidas en PowerShell o puede crear sus propias vistas en un nuevo format.ps1xml archivo y usar el Update-FormatData cmdlet para agregarlas a PowerShell.

Ejemplos

Ejemplo 1: Dar formato a la salida con una vista personalizada

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

Este comando da formato a la información sobre el Start-Transcript cmdlet en el formato definido por la vista MyView, una vista personalizada creada por el usuario. Para ejecutar este comando correctamente, primero debe crear un nuevo archivo PS1XML, definir la vista MyView y, a continuación, usar el Update-FormatData comando para agregar el archivo PS1XML a PowerShell.

Ejemplo 2: Dar formato a la salida con la vista predeterminada

Get-Process Winlogon | Format-Custom

Este comando da formato a la información sobre el proceso de Winlogon en una vista personalizada alternativa. Dado que el comando no usa el parámetro View , Format-Custom usa una vista personalizada predeterminada para dar formato a los datos.

Ejemplo 3: Solución de errores de formato

En los ejemplos siguientes se muestran los resultados de agregar los parámetros DisplayError o ShowError con una expresión.

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 el número de columnas en pantalla.

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

-DisplayError

Muestra errores en la línea de comandos. Este parámetro rara vez se usa, pero se puede usar como ayuda de depuración cuando se dan formato a expresiones en un Format-Custom comando y las expresiones no parecen estar funcionando.

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

-Expand

Da formato al objeto de colección y a los objetos dentro de la colección. Este parámetro está diseñado para dar formato a objetos que admiten la interfaz System.Collections.ICollection . El valor predeterminado es EnumOnly.

Los valores válidos son:

  • EnumOnly: muestra las propiedades de los objetos de la colección.
  • CoreOnly: muestra las propiedades del objeto de colección.
  • Ambos: muestra las propiedades del objeto de colección y los objetos de la colección.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indica al cmdlet que muestre toda la información de error. Use con los parámetros DisplayError o ShowError . De forma predeterminada, cuando se escribe un objeto de error en las secuencias de error o de presentación, solo se muestra parte de la información de error.

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

-GroupBy

Da formato al resultado en grupos basándose en una propiedad o un valor compartidos. Especifique una expresión o una propiedad del resultado.

El valor del parámetro GroupBy puede ser una nueva propiedad calculada. La propiedad calculada puede ser un bloque de script o una tabla hash. Los pares clave-valor válidos son:

  • Nombre (o etiqueta): <string>
  • Expresión: <string> o <script block>
  • FormatString: <string>

Para obtener más información, consulte about_Calculated_Properties.

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

-InputObject

Especifica los objetos a los que se dará formato. Especifique una variable que contenga los objetos, o escriba un comando o una expresión que obtenga los objetos.

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

-Property

Especifica las propiedades del objeto que aparecen en pantalla y el orden en que aparecen. Se permiten los caracteres comodín.

Si omite este parámetro, las propiedades que aparecen en pantalla dependerán del objeto que se muestre. El nombre del parámetro Property es opcional. No puede usar los parámetros Property y View en el mismo comando.

El valor del parámetro Property puede ser una nueva propiedad calculada. La propiedad calculada puede ser un bloque de script o una tabla hash. Los pares clave-valor válidos son:

  • Expresión: <string> o <script block>
  • Profundidad- <int32>

Para obtener más información, consulte about_Calculated_Properties.

Type:Object[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

Envía errores a través de la canalización. Este parámetro rara vez se usa, pero se puede usar como ayuda de depuración cuando se dan formato a expresiones en un Format-Custom comando y las expresiones no parecen estar funcionando.

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

-View

Especifica el nombre de un formato o vista alternativos. Si omite este parámetro, Format-Custom usa una vista personalizada predeterminada. No puede usar los parámetros Property y View en el mismo comando.

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

Entradas

PSObject

Puede canalizar cualquier objeto a este cmdlet.

Salidas

Microsoft.PowerShell.Commands.Internal.Format

Este cmdlet devuelve los objetos de formato que representan la presentación.

Notas

PowerShell incluye los siguientes alias para Format-Custom:

  • Todas las plataformas:
    • fc

Format-Custom está diseñado para mostrar vistas que no son solo tablas o listas. Para mostrar una vista de tabla alternativa, use Format-Table. Para mostrar una vista de lista alternativa, use Format-List.

El parámetro GroupBy supone que los objetos están ordenados. Antes de usar Format-Custom para agrupar los objetos, use Sort-Object para ordenarlos.