Compartir a través de

Format-List

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Aplica al resultado un formato de lista de propiedades, en la que cada propiedad aparece en una línea nueva.

Sintaxis

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

Description

El Format-List cmdlet da formato a la salida de un comando como una lista de propiedades en las que cada propiedad se muestra en una línea independiente. Puede usar Format-List para dar formato y mostrar todas o las propiedades seleccionadas de un objeto como una lista (Format-List -Property *).

Dado que hay más espacio disponible para cada elemento de una lista que en una tabla, PowerShell muestra más propiedades del objeto de la lista y es menos probable que se trunquen los valores de propiedad.

Ejemplos

Ejemplo 1: Dar formato a los servicios de equipo

Get-Service | Format-List

Este comando da formato de lista a la información relativa a los servicios del equipo. De forma predeterminada, se da formato de tabla a los servicios. El Get-Service cmdlet obtiene objetos que representan los servicios del equipo. El operador de canalización (|) pasa los resultados a través de la canalización a Format-List. A continuación, el Format-List comando da formato a la información del servicio en una lista y la envía al cmdlet de salida predeterminado para su visualización.

Ejemplo 2: Formato de archivos PS1XML

Estos comandos muestran información sobre los archivos PS1XML en el directorio de PowerShell como una lista.

$A = Get-ChildItem $pshome\*.ps1xml
Format-List -InputObject $A

El primer comando obtiene los objetos que representan los archivos y los almacena en la $A variable .

El segundo comando usa Format-List para dar formato a la información sobre los objetos almacenados en $A. Este comando usa el parámetro InputObject para pasar la variable a Format-List, que luego envía la salida con formato al cmdlet de salida predeterminado para su visualización.

Ejemplo 3: Dar formato a las propiedades del proceso por nombre

Este comando muestra el nombre, la prioridad base y la clase de prioridad de cada proceso del equipo.

Get-Process | Format-List -Property Name, BasePriority, PriorityClass

Usa el Get-Process cmdlet para obtener un objeto que representa cada proceso. El operador de canalización (|) pasa los objetos de proceso a través de la canalización a Format-List. Format-List da formato a los procesos como una lista de las propiedades especificadas. El nombre del parámetro Property es opcional, por lo que puede omitirlo.

Ejemplo 4: Dar formato a todas las propiedades de un proceso

Este comando muestra todas las propiedades del proceso de Winlogon.

Get-Process winlogon | Format-List -Property *

Usa el cmdlet Get-Process para obtener un objeto que represente el proceso Winlogon. El operador de canalización (|) pasa el objeto de proceso de Winlogon a través de la canalización a Format-List. El comando usa el parámetro Property para especificar las propiedades y para * indicar todas las propiedades. Dado que el nombre del parámetro Property es opcional, puede omitirlo y escribir el comando como Format-List *. Format-List envía automáticamente los resultados al cmdlet de salida predeterminado para su visualización.

Ejemplo 5: 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-List DayOfWeek,{ $_ / $null } -DisplayError

DayOfWeek    : Friday
 $_ / $null  : #ERR

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -ShowError

DayOfWeek    : Friday
 $_ / $null  :

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

Parámetros

-DisplayError

Indica que este cmdlet 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-List comando y las expresiones no parecen estar funcionando.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Expand

Especifica el objeto de colección con formato, así como los objetos 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 permitidos para este parámetro son los siguientes:

  • 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 de los objetos de la colección.
Tipo:String
Valores aceptados:CoreOnly, EnumOnly, Both
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-Force

Indica que este cmdlet muestra toda la información de error. Use con el parámetro 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 información de error.

También es necesario cuando se aplica formato a determinados tipos de .NET. Para más información, vea la sección Notas.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-GroupBy

Especifica la salida en grupos en función de una propiedad o 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.

Tipo:Object
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín: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.

Tipo:PSObject
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín: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:

  • Name (o Label) - <string>
  • Expression - <string> o <script block>
  • FormatString - <string>

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

Tipo:Object[]
Posición:0
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:True

-ShowError

Indica que el cmdlet 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-List comando y las expresiones no parecen estar funcionando.

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False

-View

Especifica el nombre de un formato o vista de lista alternativo. No puede usar los parámetros Property y View en el mismo comando.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín: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 lista.

Notas

PowerShell incluye los siguientes alias para Format-List:

  • Todas las plataformas:
    • fl

Los cmdlets de formato, como Format-List, organizan los datos que se van a mostrar, pero no los muestran. Los datos se muestran mediante las características de salida de PowerShell y los cmdlets que contienen el Out verbo (los Out cmdlets), como Out-Host o Out-File.

Si no usa un cmdlet de formato, PowerShell aplica ese formato predeterminado para cada objeto que muestra.

El parámetro GroupBy supone que los objetos están ordenados. Use Sort-Object antes de usar Format-List 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 lista; de lo contrario, se produce un error en el comando. Si la vista alternativa es una tabla, use Format-Table. Si la vista alternativa no es una lista o una tabla, use Format-Custom.

Si desea usar Format-List con el parámetro Property , debe incluir el parámetro Force en cualquiera de las condiciones siguientes: