Partager via

Export-FormatData

  • Référence
Module:
Microsoft.PowerShell.Utility

Enregistre les données de mise en forme de la session active dans un fichier de mise en forme.

Syntaxe

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

Description

L’applet de commande Export-FormatData crée des fichiers de mise en forme Windows PowerShell (format.ps1xml) à partir des objets de mise en forme de la session active. Il prend les objets ExtendedTypeDefinition qui Get-FormatData retourne et les enregistre dans un fichier au format XML.

Windows PowerShell utilise les données dans les fichiers de mise en forme (format.ps1xml) pour générer l’affichage par défaut des objets Microsoft .NET Framework dans la session. Vous pouvez afficher et modifier les fichiers de mise en forme et utiliser l’applet de commande Update-FormatData pour ajouter les données de mise en forme à une session.

Pour plus d’informations sur la mise en forme des fichiers dans Windows PowerShell, consultez about_Format.ps1xml.

Exemples

Exemple 1 : Exporter des données de format de session

PS C:\> Get-FormatData -TypeName "*" | Export-FormatData -Path "allformat.ps1xml" -IncludeScriptBlock

Cette commande exporte toutes les données de format de la session vers le fichier AllFormat.ps1xml.

La commande utilise l’applet de commande Get-FormatData pour obtenir les données de format dans la session. La valeur * (all) du paramètre TypeName indique à l’applet de commande d’obtenir toutes les données de la session.

La commande utilise un opérateur de pipeline (|) pour envoyer les données de format à partir de la commande Get-FormatData à l’applet de commande Export-FormatData, qui exporte les données de format dans le fichier AllFormat.ps1.

La commande Export-FormatData utilise le paramètre IncludeScriptBlock pour inclure des blocs de script dans les données de format du fichier.

Exemple 2 : Exporter des données de format pour un type

PS C:\> $F = Get-FormatData -TypeName "helpinfoshort"
PS C:\> Export-FormatData -InputObject $F -Path "c:\test\help.format.ps1xml" -IncludeScriptBlock

Ces commandes exportent les données de format du type HelpInfoShort vers le fichier Help.format.ps1xml.

La première commande utilise l’applet de commande Get-FormatData pour obtenir les données de format du type HelpInfoShort et l’enregistre dans la variable $F.

La deuxième commande utilise le paramètre InputObject de l’applet de commande Export-FormatData pour entrer les données de format enregistrées dans la variable $F. Il utilise également le paramètre IncludeScriptBlock pour inclure des blocs de script dans la sortie.

Exemple 3 : Exporter des données de format sans bloc de script

PS C:\> Get-FormatData -TypeName "System.Diagnostics.Process" | Export-FormatData -Path process.format.ps1xml
PS C:\> Update-FormatData -PrependPath ".\process.format.ps1xml"
PS C:\> 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

Cet exemple montre l’effet d’omettre le paramètre IncludeScriptBlock à partir d’une commande Export-FormatData.

La première commande utilise l’applet de commande Get-FormatData pour obtenir les données de format pour l’objet System.Diagnostics.Process retourné par l’applet de commande Get-Process. La commande utilise un opérateur de pipeline (|) pour envoyer les données de mise en forme à l’applet de commande Export-FormatData , qui l’exporte vers le fichier Process.format.ps1xml dans le répertoire actif.

Dans ce cas, la commande Export-FormatData n’utilise pas le paramètre IncludeScriptBlock.

La deuxième commande utilise l’applet de commande Update-FormatData pour ajouter le fichier Process.format.ps1xml à la session active. La commande utilise le paramètre PrependPath pour vous assurer que les données de mise en forme des objets de traitement dans le fichier Process.format.ps1xml sont trouvées avant les données de mise en forme standard pour les objets de traitement.

La troisième commande affiche les effets de cette modification. La commande utilise l’applet de commande Get-Process pour obtenir des processus dont le nom commence par P. La sortie indique que les valeurs de propriété calculées à l’aide de blocs de script sont manquantes dans l’affichage.

Paramètres

-Force

Force l’exécution de la commande sans demander la confirmation de l’utilisateur.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IncludeScriptBlock

Indique si les blocs de script dans les données de format sont exportés.

Étant donné que les blocs de script contiennent du code et peuvent être utilisés malveillantment, ils ne sont pas exportés par défaut.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InputObject

Spécifie les objets de données de format à exporter. Entrez une variable qui contient les objets ou une commande qui obtient les objets, comme une commande Get-FormatData. Vous pouvez également diriger les objets de Get-FormatData vers export-formatData.

Type:ExtendedTypeDefinition[]
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-LiteralPath

Spécifie un emplacement pour le fichier de sortie. Contrairement au paramètre Path , la valeur de LiteralPath est utilisée exactement comme il est typé. Aucun caractère n’est interprété comme des caractères génériques. Si le chemin inclut des caractères d’échappement, placez-le entre guillemets simples. Les guillemets simples indiquent à Windows PowerShell de ne pas interpréter de caractères comme séquences d’échappement.

Type:String
Alias:PSPath
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NoClobber

Inidicatest que l’applet de commande ne remplace pas les fichiers existants. Par défaut, Export-FormatData remplace les fichiers sans avertissement, sauf si le fichier a l’attribut en lecture seule.

Pour diriger export-formatData pour remplacer les fichiers en lecture seule, utilisez le paramètre Force.

Type:SwitchParameter
Alias:NoOverwrite
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Path

Spécifie un emplacement pour le fichier de sortie. Entrez un chemin d’accès (facultatif) et un nom de fichier avec une extension de nom de fichier format.ps1xml. Si vous omettez le chemin d’accès, Export-FormatData crée le fichier dans le répertoire actif.

Si vous utilisez une extension de nom de fichier autre que .ps1xml, l’applet de commande Update-FormatData ne reconnaît pas le fichier.

Si vous spécifiez un fichier existant, Export-FormatData remplace le fichier sans avertissement, sauf si le fichier a l’attribut en lecture seule. Pour remplacer un fichier en lecture seule, utilisez le paramètre Forcer. Pour empêcher le remplacement des fichiers, utilisez le paramètre NoClobber.

Type:String
Alias:FilePath
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

ExtendedTypeDefinition

Vous pouvez diriger objets ExtendedTypeDefinition de get-FormatData vers export-formatData.

Sorties

None

export-FormatData ne retourne aucun objet. Il génère un fichier et l’enregistre dans le chemin d’accès spécifié.

Notes

  • Pour utiliser n’importe quel fichier de mise en forme, y compris un fichier de mise en forme exporté, la stratégie d’exécution de la session doit autoriser l’exécution de scripts et de fichiers de configuration. Pour plus d’informations, consultez about_Execution_Policies.