Compartir vía

Format-Custom

Módulo:
Microsoft.PowerShell.Utility Module

Usa una vista personalizada para dar formato a la salida.

Sintaxis

Default (Es el valor predeterminado). 

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

Description

El cmdlet Format-Custom 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 ni listas. Puede usar las vistas definidas en PowerShell o puede crear sus propias vistas en un nuevo archivo format.ps1xml y usar el cmdlet Update-FormatData 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 cmdlet Start-Transcript 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 comando Update-FormatData 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 formatea información sobre el proceso Winlogon en una vista alternativa personalizada. Dado que el comando no usa el parámetro View, 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 de la pantalla.

Propiedades del parámetro

Tipo:Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes: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 comando Format-Custom y las expresiones no parecen funcionar.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Expand

Da formato al objeto de colección, así como a los objetos de la colección. Este parámetro está diseñado para dar formato a los 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.

Propiedades del parámetro

Tipo:String
Valor predeterminado:EnumOnly
Valores aceptados:CoreOnly, EnumOnly, Both
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Force

Dirige el cmdlet para mostrar 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 visualización, solo se muestra parte de la información de error.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-GroupBy

Da formato a la salida en grupos en función de una propiedad o valor compartidos. Escriba una expresión o una propiedad de la salida. El parámetro GroupBy espera que los objetos estén ordenados. Use el cmdlet Sort-Object antes de usar Format-Custom para agrupar los objetos.

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.

Propiedades del parámetro

Tipo:Object
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-InputObject

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

Propiedades del parámetro

Tipo:PSObject
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Property

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

Si omite este parámetro, las propiedades que aparecen en la pantalla dependen del objeto que se muestra. El nombre del parámetro Property es opcional. No se pueden usar los parámetros Property y View en un solo 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.

Propiedades del parámetro

Tipo:

Object[]

Valor predeterminado:None
Admite caracteres comodín:True
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-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 comando Format-Custom y las expresiones no parecen funcionar.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-View

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

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

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 ni 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.