Usa una vista personalizada para dar formato a la salida.
Sintaxis
Format-Custom [[-Property] <Object[]>] [-Depth <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
Descripción
El cmdlet Format-Custom da formato al resultado de un comando en una vista alternativa. Format-Custom se ha diseñado para mostrar vistas que no sean simplemente tablas o listas. 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.
Parámetros
-Depth <int>
Especifica el número de columnas de la presentación.
|
¿Requerido? |
false |
|
¿Posición? |
named |
|
Valor predeterminado |
|
|
¿Aceptar canalización? |
false |
|
¿Aceptar caracteres comodín? |
false |
-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:
-- Expression <cadena> o <bloque de script>
-- Depth <int32>
|
¿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 alternativo o una vista alternativa. Si omite este parámetro, Format-Custom utiliza una vista personalizada predeterminada. 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-Custom. |
|
Salidas |
Microsoft.PowerShell.Commands.Internal.Format Format-Custom devuelve los objetos de formato que representan la presentación. |
Notas
Format-Custom se ha diseñado para mostrar otras vistas que no sean simplemente tablas o listas. Para mostrar una vista de tabla alternativa, use Format-Table. Para mostrar una vista de lista alternativa, use Format-List.
También puede hacer referencia a Format-Custom mediante su alias integrado, "fc". Para obtener más información, vea about_Aliases.
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.
Ejemplo 1
C:\PS>get-command start-transcript | format-custom -view MyView Descripción ----------- Este comando aplica a la información sobre el cmdlet Start-Transcript el formato definido en la vista MyView, una vista personalizada creada por el usuario. Para ejecutar correctamente este comando, 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 Windows PowerShell.
Ejemplo 2
C:\PS>get-process Winlogon | format-custom Descripción ----------- Este comando aplica a la información sobre el proceso Winlogon el formato de una vista alternativa personalizada. Dado que el comando no usa el parámetro View, Format-Custom usa una vista personalizada predeterminada para dar formato a los datos.