Aplica a la salida el formato de una lista de propiedades en la que cada propiedad aparece en una nueva línea.
Sintaxis
Format-List [[-Property] <Object[]>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
Descripción
El cmdlet Format-List aplica a la salida el formato de una lista de propiedades en la que cada propiedad aparece en una línea diferente. Puede utilizar Format-List para dar formato y mostrar como una lista todas las propiedades o propiedades seleccionadas de un objeto (format-list *).
Dado que cada elemento dispone de más espacio en una lista que en una tabla, Windows PowerShell muestra más propiedades del objeto en la lista, y hay menos probabilidades de que se trunquen los valores de las propiedades.
Parámetros
-DisplayError
Muestra los errores en la línea de comandos.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Expand <string>
Da formato al objeto Collection, así como a los objetos de la colección. Este parámetro se ha diseñado para dar un formato a los objetos que sea compatible con la interfaz ICollection (System.Collections). 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 Collection.
-- Both: muestra las propiedades del objeto Collection y de los objetos de la colección.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-Force
Indica al cmdlet que muestre toda la información de error. Se utiliza con los parámetros DisplayError o ShowError. De forma predeterminada, cuando el objeto de error se escribe en la secuencia de error o de presentación, se muestra solo parte de la información de error.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-GroupBy <Object>
Da formato a la salida de los grupos en función de un valor o una propiedad compartida. Especifique una expresión o una propiedad de la salida.
El valor del parámetro GroupBy puede ser una nueva propiedad calculada. Para crear una propiedad calculada, utilice una tabla hash. Las claves válidas son:
-- Name (o Label) <cadena>
-- Expression <cadena> o <bloque de script>
-- FormatString <cadena>
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-InputObject <psobject>
Especifica los objetos a los que se les va a dar formato. Especifique la variable que contiene los objetos o escriba un comando o una expresión que los obtenga.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
true (ByValue) |
|
¿Aceptar caracteres comodín? |
false |
-Property <Object[]>
Especifica las propiedades del objeto que se van a mostrar y el orden en el que van a aparecer. Se permite el uso de caracteres comodín.
Si se omite este parámetro, las propiedades que aparezcan en la presentación dependerán del objeto que se está mostrando. El nombre del parámetro ("Property") es opcional. Los parámetros Property y View no se pueden usar en el mismo comando.
El valor del parámetro Property puede ser una nueva propiedad calculada. Para crear una propiedad calculada, utilice una tabla hash. Las claves válidas son:
-- Name (o Label) <cadena>
-- Expression <cadena> o <bloque de script>
-- FormatString <cadena>
|
¿Requerido? |
false |
|
¿Posición? |
1 |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-ShowError
Envía los errores a través de la canalización.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-View <string>
Especifica el nombre de un formato de lista alternativo o una vista alternativa. Los parámetros Property y View no se pueden usar en el mismo comando.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, vea about_Commonparameters.
Entradas y salidas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet. El tipo devuelto es el tipo de los objetos que el cmdlet devuelve.
|
Entradas |
System.Management.Automation.PSObject Puede canalizar cualquier objeto a Format-List. |
|
Salidas |
Microsoft.PowerShell.Commands.Internal.Format Format-List devuelve los objetos de formato que representan la lista. |
Notas
También puede hacer referencia a Format-List mediante su alias integrado, "FL". Para obtener más información, vea about_Aliases.
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 Windows PowerShell y los cmdlets que contienen el verbo Out (cmdlets Out), como Out-Host, Out-File y Out-Printer.
Si no se usa ningún cmdlet de formato, Windows PowerShell aplica el formato predeterminado a cada objeto mostrado.
El parámetro GroupBy presupone que los objetos están ordenados. Antes de usar Format-Custom para agrupar los objetos, use Sort-Object para ordenarlos.
El parámetro View permite especificar un formato alternativo para la tabla. Puede usar las vistas definidas en los archivos *.format.PS1XML del directorio Windows PowerShell o puede crear sus propias vistas en nuevos archivos PS1XML y usar el cmdlet Update-FormatData para agregarlas a Windows PowerShell.
La vista alternativa del parámetro View debe usar el formato de lista; de no ser así, se producirá un error al ejecutar el comando. Si la vista alternativa es una tabla, use Format-Table. Si la vista alternativa no es una lista ni una tabla, use Format-Custom.
Ejemplo 1
C:\PS>get-service | format-list Descripción ----------- Este comando aplica el formato de lista a la información sobre los servicios del equipo. De manera predeterminada, a los servicios se les asigna un formato de tabla. El cmdlet Get-Service obtiene los objetos que representan los servicios de un equipo. El operador de canalización (|) pasa los resultados a través de la canalización a Format-List. A continuación, el comando Format-List aplica a la información de los servicios el formato de una lista y la envía al cmdlet de salida predeterminado para mostrarla.
Ejemplo 2
C:\PS>$a = get-childitem $pshome\*.ps1xml Descripción ----------- Estos comandos muestran información sobre los archivos PS1XML del directorio de Windows PowerShell en forma de lista. El primer comando obtiene los objetos que representan los archivos y los almacena en la variable $a. 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 envía el resultado con formato al cmdlet de salida predeterminado para mostrarlo.
Ejemplo 3
C:\PS>get-process | format-list -property name, basepriority, priorityclass Descripción ----------- Este comando muestra el nombre, la prioridad base y la clase de propiedad de cada proceso del equipo. Usa el cmdlet Get-Process para obtener los objetos que representan cada proceso. El operador de canalización (|) pasa los objetos de proceso a través de la canalización a Format-List, que aplica a los procesos el formato de una lista de las propiedades especificadas. El nombre del parámetro "Property" es opcional y, por tanto, puede omitirse.
Ejemplo 4
C:\PS>get-process winlogon | format-list -property * Descripción ----------- Este comando muestra todas las propiedades del proceso Winlogon. Usa el cmdlet Get-Process para obtener el objeto que representa este proceso. El operador de canalización (|) pasa el objeto del proceso Winlogon a través de la canalización a Format-List. El comando usa el parámetro Property para especificar las propiedades y usa * para indicar todas las propiedades. Dado que el nombre del parámetro Property es opcional, puede omitirlo y escribir el comando de esta manera: "format-list *". Format-List envía automáticamente los resultados al cmdlet de salida predeterminado para mostrarlos.