Export-FormatData
Enregistre les données de mise en forme de la session active dans un fichier de mise en forme.
Syntax
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-Path <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
Export-FormatData
-InputObject <ExtendedTypeDefinition[]>
-LiteralPath <String>
[-Force]
[-NoClobber]
[-IncludeScriptBlock]
[<CommonParameters>]
Description
L’applet Export-FormatData
de commande crée des fichiers de mise en forme PowerShell (format.ps1xml) à partir des objets de mise en forme de la session active. Elle prend les objets ExtendedTypeDefinition qui Get-FormatData
retournent et les enregistrent dans un fichier au format XML.
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 la mise en forme des fichiers dans PowerShell, consultez about_Format.ps1xml.
Exemples
Exemple 1 : Exporter des données au format de session
Get-FormatData -TypeName "*" | Export-FormatData -Path "allformat.ps1xml" -IncludeScriptBlock
Cette commande exporte toutes les données de format de la session dans le fichier AllFormat.ps1xml.
La commande utilise l’applet Get-FormatData
de commande pour obtenir les données de format dans la session. La valeur *
(all) pour le 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 de la Get-FormatData
commande à l’applet Export-FormatData
de commande, qui exporte les données de format dans le fichier AllFormat.ps1.
La Export-FormatData
commande utilise le paramètre IncludeScriptBlock pour inclure des blocs de script dans les données de format dans le fichier.
Exemple 2 : Exporter des données de format pour un type
$F = Get-FormatData -TypeName "helpinfoshort"
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 Get-FormatData
de commande pour obtenir les données de format du type HelpInfoShort et les enregistre dans la $F
variable.
La deuxième commande utilise le paramètre InputObject de l’applet Export-FormatData
de commande pour entrer les données de format enregistrées dans la $F
variable. 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
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
Cet exemple montre l’effet de l’omission du paramètre IncludeScriptBlock d’une Export-FormatData
commande.
La première commande utilise l’applet Get-FormatData
de commande pour obtenir les données de format de l’objet System.Diagnostics.Process que l’applet de commande Get-Process retourne. La commande utilise un opérateur de pipeline (|
) pour envoyer les données de mise en forme à l’applet Export-FormatData
de commande, qui les exporte vers le fichier Process.format.ps1xml dans le répertoire actif.
Dans ce cas, la Export-FormatData
commande n’utilise pas le paramètre IncludeScriptBlock .
La deuxième commande utilise l’applet Update-FormatData
de commande pour ajouter le fichier Process.format.ps1xml à la session active. La commande utilise le paramètre PrependPath pour s’assurer que les données de mise en forme des objets de processus dans le fichier Process.format.ps1xml sont trouvées avant les données de mise en forme standard pour les objets de processus.
La troisième commande montre les effets de cette modification. La commande utilise l’applet Get-Process
de commande pour obtenir des processus dont les noms commencent 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 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IncludeScriptBlock
Indique si les blocs de script dans les données de format sont exportés.
Comme les blocs de script contiennent du code et peuvent être utilisés à des fins malveillantes, par défaut, ils ne sont pas exportés.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
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, telle qu’une Get-FormatData
commande. Vous pouvez également diriger les objets de Get-FormatData
vers Export-FormatData
.
Type: | ExtendedTypeDefinition[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Spécifie l'emplacement du fichier de sortie. Contrairement au paramètre Path, la valeur du paramètre LiteralPath est utilisée exactement telle que vous la tapez. Aucun caractère n’est interprété en tant que caractère générique. Si le chemin d’accès inclut des caractères d’échappement, mettez-le entre des guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme des séquences d’échappement.
Type: | String |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-NoClobber
Indique que l’applet de commande ne remplace pas les fichiers existants. Par défaut, remplace les fichiers sans avertissement, Export-FormatData
sauf si le fichier a l’attribut lecture seule.
Pour diriger Export-FormatData
vers le remplacement des fichiers en lecture seule, utilisez le paramètre Force .
Type: | SwitchParameter |
Aliases: | NoOverwrite |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Spécifie l'emplacement du 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 Update-FormatData
de commande 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 lecture seule. Pour remplacer un fichier en lecture seule, utilisez le paramètre Force . Pour empêcher le remplacement de fichiers, utilisez le paramètre NoClobber .
Type: | String |
Aliases: | FilePath |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entrées
Vous pouvez diriger des objets ExtendedTypeDefinition à partir de Get-FormatData
vers cette applet de commande.
Sorties
None
Cette applet de commande ne retourne pas de sortie. Il génère un fichier et l'enregistre dans le chemin d'accès spécifié.
Notes
- Pour utiliser un 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 des scripts et des fichiers de configuration. Pour plus d’informations, consultez about_Execution_Policies.