Compartir vía

Export-FormatData

Módulo:
Microsoft.PowerShell.Utility Module

Guarda los datos de formato de la sesión actual en un archivo de formato.

Sintaxis

ByPath (Es el valor predeterminado). 

Export-FormatData
    -InputObject <ExtendedTypeDefinition[]>
    -Path <String>
    [-Force]
    [-NoClobber]
    [-IncludeScriptBlock]
    [<CommonParameters>]

ByLiteralPath 

Export-FormatData
    -InputObject <ExtendedTypeDefinition[]>
    -LiteralPath <String>
    [-Force]
    [-NoClobber]
    [-IncludeScriptBlock]
    [<CommonParameters>]

Description

El cmdlet Export-FormatData crea archivos de formato de PowerShell (format.ps1xml) a partir de los objetos de formato de la sesión actual. Toma los objetos ExtendedTypeDefinition que devuelve y los guarda en un archivo en formato XML.

PowerShell usa los datos de los archivos de formato (format.ps1xml) para generar la presentación predeterminada de los objetos de Microsoft .NET Framework en la sesión. Puede ver y editar los archivos de formato y usar el cmdlet Update-FormatData para agregar los datos de formato a una sesión.

Para obtener más información sobre el formato de archivos en PowerShell, consulte about_Format.ps1xml.

Ejemplos

Ejemplo 1: Exportar datos de formato de sesión

Get-FormatData -TypeName "*" |
    Export-FormatData -Path "AllFormat.ps1xml" -IncludeScriptBlock

Este comando exporta todos los datos de formato de la sesión al archivo AllFormat.ps1xml.

El comando usa el cmdlet Get-FormatData para obtener los datos de formato en la sesión. El valor * (todos) para el parámetro TypeName indica al cmdlet que debe obtener todos los datos de la sesión.

El comando usa un operador de canalización (|) para enviar los datos de formato desde el comando Get-FormatData al cmdlet Export-FormatData, que exporta los datos de formato al archivo AllFormat.ps1xml.

El comando Export-FormatData usa el parámetro IncludeScriptBlock para incluir bloques de script en los datos de formato del archivo.

Ejemplo 2: Exportación de datos de formato para un tipo

$F = Get-FormatData -TypeName "HelpInfoShort"
Export-FormatData -InputObject $F -Path "C:\test\Help.format.ps1xml" -IncludeScriptBlock

Estos comandos exportan los datos de formato del tipo de HelpInfoShort al archivo Help.format.ps1xml.

El primer comando utiliza el cmdlet Get-FormatData para obtener los datos de formato para el tipo HelpInfoShort de, y los guarda en la variable $F.

El segundo comando usa el parámetro InputObject del cmdlet Export-FormatData para escribir los datos de formato guardados en la variable $F. También usa el parámetro IncludeScriptBlock para incluir bloques de script en la salida.

Ejemplo 3: Exportación de datos de formato sin un bloque de script

Get-FormatData -TypeName "System.Diagnostics.Process" |
    Export-FormatData -Path Process.format.ps1xml
Update-FormatData -PrependPath ".\Process.format.ps1xml"
Get-Process p*

Handles  NPM(K)  PM(K)  WS(K) VM(M)   CPU(s)    Id ProcessName
-------  ------  -----  ----- -----   ------    -- -----------
323                                       5600 powershell
336                                       3900 powershell_ise
138                                       4076 PresentationFontCache

En este ejemplo se muestra el efecto de omitir el parámetro IncludeScriptBlock de un comando Export-FormatData.

El primer comando usa el cmdlet Get-FormatData para obtener los datos de formato del objeto System.Diagnostics.Process que devuelve el cmdlet Get-Process. El comando usa un operador de canalización (|) para enviar los datos de formato al cmdlet Export-FormatData, que lo exporta al archivo Process.format.ps1xml en el directorio actual.

En este caso, el comando Export-FormatData no usa el parámetro IncludeScriptBlock.

El segundo comando usa el cmdlet Update-FormatData para agregar el archivo Process.format.ps1xml a la sesión actual. El comando usa el parámetro PrependPath para asegurarse de que los datos de formato de los objetos de proceso en el archivo Process.format.ps1xml se encuentran antes de que se encuentren los datos de formato estándar para los objetos de proceso.

El tercer comando muestra los efectos de este cambio. El comando usa el cmdlet Get-Process para obtener los procesos cuyos nombres comienzan por P. La salida muestra que los valores de propiedad calculados mediante bloques de script faltan en la pantalla.

Parámetros

-Force

Obliga a que el comando se ejecute sin pedir confirmación del usuario.

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

-IncludeScriptBlock

Indica si se exportan los bloques de script de los datos de formato.

Dado que los bloques de script contienen código y se pueden usar de forma malintencionada, no se exportan de forma predeterminada.

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

-InputObject

Especifica el formato de los objetos de datos que se van a exportar. Escriba una variable que contenga los objetos o un comando que obtiene los objetos, como un comando Get-FormatData. También puede canalizar los objetos de Get-FormatData a Export-FormatData.

Propiedades del parámetro

Tipo:

ExtendedTypeDefinition[]

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

Conjuntos de parámetros

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

-LiteralPath

Especifica una ubicación para el archivo de salida. A diferencia del parámetro Path, el valor de LiteralPath se usa exactamente como se escribe. Ninguno de los caracteres se interpreta como caracteres comodín. Si la ruta de acceso incluye caracteres de escape, escríbala entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:PSPath, LP

Conjuntos de parámetros

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

-NoClobber

Indica que el cmdlet no sobrescribe los archivos existentes. De forma predeterminada, Export-FormatData sobrescribe los archivos sin advertencia a menos que el archivo tenga el atributo de solo lectura.

Para hacer que Export-FormatData sobrescriba archivos de solo lectura, use el parámetro Force.

Propiedades del parámetro

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

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

-Path

Especifica una ubicación para el archivo de salida. Escriba una ruta de acceso (opcional) y un nombre de archivo con una extensión de nombre de archivo format.ps1xml. Si omite la ruta de acceso, Export-FormatData crea el archivo en el directorio actual.

Si usa una extensión de nombre de archivo distinta de .ps1xml, el cmdlet Update-FormatData no reconocerá el archivo.

Si especifica un archivo existente, Export-FormatData sobrescribe el archivo sin advertencia, a menos que el archivo tenga el atributo de solo lectura. Para sobrescribir un archivo de solo lectura, use el parámetro Force. Para evitar que los archivos se sobrescriban, use el parámetro NoClobber.

Propiedades del parámetro

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

Conjuntos de parámetros

ByPath
Posición:Named
Mandatory:True
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

ExtendedTypeDefinition

Puede canalizar objetos ExtendedTypeDefinition desde Get-FormatData a este cmdlet.

Salidas

None

Este cmdlet no devuelve ninguna salida. Genera un archivo y lo guarda en la ruta de acceso especificada.

Notas

  • Para usar cualquier archivo de formato, incluido un archivo de formato exportado, la directiva de ejecución de la sesión debe permitir que se ejecuten scripts y archivos de configuración. Para obtener más información, vea about_Execution_Policies.