Enregistre les données de mise en forme de la session active dans un fichier de mise en forme.
Syntaxe
Export-FormatData [-Force] [-IncludeScriptBlock] [-InputObject <ExtendedTypeDefinition[]>] [-NoClobber] [-Path <string>] [<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. Elle prend les objets ExtendedTypeDefinition retournés par Get-FormatData et les enregistre dans un fichier au format XML.
Windows PowerShell utilise les données des 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 les fichiers de mise en forme dans Windows PowerShell, consultez about_Format.ps1xml.
Paramètres
-Force
Remplace un fichier de sortie existant, même si ce fichier possède l'attribut de lecture seule.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-IncludeScriptBlock
Détermine si les blocs de script dans les données de mise en forme sont exportés.
Étant donné que les blocs de script contiennent du code et peuvent être utilisés de manière malveillante, ils ne sont pas exportés par défaut.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
False |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-InputObject <ExtendedTypeDefinition[]>
Spécifie les objets de données de mise en forme à exporter. Entrez une variable qui contient les objets ou une commande qui obtient les objets (commande Get-FormatData, par exemple). Vous pouvez également diriger les objets de Get-FormatData vers Export-FormatData.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByValue) |
|
Accepter les caractères génériques ? |
false |
-NoClobber
Empêche l'applet de commande de remplacer des fichiers existants. Par défaut, Export-FormatData remplace les fichiers sans avertissement, à moins que le fichier ait l'attribut de lecture seule.
Pour demander à Export-FormatData de remplacer les fichiers en lecture seule, utilisez le paramètre Force.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Path <string>
Spécifie un emplacement pour le fichier de sortie. Entrez un chemin d'accès (facultatif) et un nom de fichier comportant l'extension 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îtra pas le fichier.
Si vous spécifiez un fichier existant, Export-FormatData le remplace sans avertissement, à moins que le fichier ait l'attribut de lecture seule. Pour remplacer un fichier en lecture seule, utilisez le paramètre Force. Pour empêcher le remplacement des fichiers, utilisez le paramètre NoClobber.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
aucun |
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
System.Management.Automation.ExtendedTypeDefinition Vous pouvez également diriger les objets ExtendedTypeDefinition de Get-FormatData vers Export-FormatData. |
|
Sorties |
Aucun Export-FormatData ne retourne pas d'objets. Il génère un fichier et l'enregistre dans le chemin d'accès spécifié. |
Remarques
Pour pouvoir 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 permettre l'exécution des scripts et des fichiers de configuration. Pour plus d'informations, consultez about_Execution_Policies.
Exemple 1
C:\PS>get-formatdata -typename * | export-formatdata -path allformat.ps1xml -IncludeScriptBlock Description ----------- Cette commande exporte toute les données de mise en forme de la session vers le fichier AllFormat.ps1xml. La commande utilise l'applet de commande Get-FormatData pour obtenir les données de mise en forme de la session. La valeur * (tout) attribuée au paramètre TypeName demande à 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 mise en forme de la commande Get-FormatData vers l'applet de commande Export-FormatData, qui les exporte ensuite vers le fichier AllFormat.ps1. La commande Export-FormatData utilise le paramètre IncludeScriptBlock pour inclure des blocs de script dans les données de mise en forme du fichier.
Exemple 2
C:\PS>$f = get-formatdata -typename helpinfoshort C:\PS> export-formatdata -inputObject $f -path c:\test\help.format.ps1xml -IncludeScriptBlock Description ----------- Ces commandes exportent les données de mise en forme 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 mise en forme du type HelpInfoShort, puis les 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 mise en forme enregistrées dans la variable $f. Elle utilise également le paramètre IncludeScriptBlock pour inclure les blocs de script dans la sortie.
Exemple 3
C:\PS>get-formatdata -typename System.Diagnostics.Process | export-FormatData -path process.format.ps1xml
C:\PS> Update-FormatData -prependPath .\process.format.ps1xml
C:\PS> 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
Description
-----------
Cet exemple illustre l'incidence de l'omission du paramètre IncludeScriptBlock d'une commande Export-FormatData.
La première commande utilise l'applet de commande Get-FormatData pour obtenir les données de mise en forme de l'objet System.Diagnostics.Process retourné par l'applet de commande Get-Process. Elle utilise un opérateur de pipeline (|) pour envoyer les données de mise en forme à l'applet de commande Export-FormatData, qui les 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. Elle utilise le paramètre PrependPath pour garantir que les données de mise en forme des objets processus dans le fichier Process.format.ps1xml sont recherchées avant les données de mise en forme standard des objets processus.
La troisième commande affiche les effets de cette modification. Elle utilise l'applet de commande Get-Process pour obtenir les processus dont le nom commence par « P ». La sortie montre que les valeurs de propriété calculées à l'aide des blocs de script sont manquantes dans l'affichage.
Voir aussi