Format-Wide

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Aplica a los objetos un formato de tabla ancha que muestra únicamente una propiedad de cada objeto.

Syntax

Format-Wide
      [[-Property] <Object>]
      [-AutoSize]
      [-Column <int>]
      [-GroupBy <Object>]
      [-View <string>]
       [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <string>]
      [-InputObject <psobject>] 
      [<CommonParameters>]

Description

El Format-Wide cmdlet da formato a los objetos como una tabla ancha que muestra solo una propiedad de cada objeto. Puede usar el parámetro Property para determinar qué propiedad se muestra.

Ejemplos

Ejemplo 1: Formato de nombres de archivos en el directorio actual

Este comando muestra los nombres de archivos del directorio actual en tres columnas distribuidas en la pantalla.

Get-ChildItem | Format-Wide -Column 3

El Get-ChildItem cmdlet obtiene objetos que representan cada archivo del directorio. El operador de canalización (|) pasa los objetos de archivo a través de la canalización a Format-Wide, que los da formato para la salida. El parámetro Column especifica el número de columnas.

Ejemplo 2: Formato de nombres de claves del Registro

Este comando muestra los nombres de las claves del Registro en la HKEY_CURRENT_USER\Software\Microsoft clave.

Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize

El Get-ChildItem cmdlet obtiene objetos que representan las claves. La ruta de acceso se especifica como HKCU:, una de las unidades expuestas por el proveedor del Registro de PowerShell, seguida de la ruta de acceso de la clave. El operador de canalización (|) pasa los objetos de clave del Registro a través de la canalización a Format-Wide, que los da formato para la salida. El parámetro Property especifica el nombre de la propiedad y el parámetro AutoSize ajusta las columnas para mejorar la legibilidad.

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.

PS /> Get-Date | Format-Wide { $_ / $null } -DisplayError


#ERR

PS /> Get-Date | Format-Wide { $_ / $null } -ShowError


Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 8:18:01 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Parámetros

-AutoSize

Ajusta el tamaño de la columna y el número de columnas según el ancho de los datos. De forma predeterminada, el tamaño y el número de las columnas dependen de la vista. No puede usar los parámetros AutoSize y Column en el mismo comando.

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

-Column

Especifica el número de columnas en pantalla. No puede usar los parámetros AutoSize y Column en el mismo comando.

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-Wide 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.
  • Both: muestra las propiedades del objeto de colección y las propiedades de 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 que este cmdlet invalida las restricciones que impiden que el comando se realice correctamente, solo para que los cambios no pongan en peligro la seguridad. Por ejemplo, Force invalidará el atributo de solo lectura o creará directorios para completar una ruta de acceso de archivo, pero no intentará cambiar los permisos de archivo.

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:

  • Name (o Label) - <string>
  • Expression - <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 va a 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 la propiedad de objeto que aparece en la pantalla. 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:

  • Expression - <string> o <script block>
  • FormatString - <string>

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-Wide 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 de tabla alternativo. 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 objetos de formato que representan la tabla.

Notas

PowerShell incluye los siguientes alias para Format-Wide:

  • Todas las plataformas:
    • fw

El parámetro GroupBy supone que los objetos están ordenados. Use Sort-Object antes de usar Format-Custom para agrupar los objetos.

El parámetro View permite especificar un formato alternativo para la tabla. Puede usar las vistas definidas en los *.format.PS1XML archivos del directorio de PowerShell o puede crear sus propias vistas en nuevos archivos PS1XML y usar el Update-FormatData cmdlet para incluirlas en PowerShell.

La vista alternativa para el parámetro View debe usar el formato de tabla; si no es así, se produce un error en el comando. Si la vista alternativa es una lista, use Format-List. Si la vista alternativa no es una lista ni una tabla, use Format-Custom.