Export-FormatData

Module:

Microsoft.PowerShell.Utility Module

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

Syntaxe

ByPath (Par défaut)

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

ByLiteralPath

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 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.

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 PowerShell, consultez about_Format.ps1xml.

Exemples

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

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 le cmdlet Get-FormatData pour obtenir les données de format dans la session. Une valeur de * (tous) pour le paramètre TypeName dirige l’applet de commande pour 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 commande Get-FormatData à l’applet de commande Export-FormatData, qui exporte les données de format dans le fichier AllFormat.ps1xml.

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

$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 dans le fichier Help.format.ps1xml.

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

La deuxième commande utilise le paramètre InputObject de l’applet de commande pour entrer les données de format enregistrées dans la 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 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 qui ont des noms commençant 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.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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.

Propriétés du paramètre

Type:	ExtendedTypeDefinition[]
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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 elle est tapée. 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 séquences d’échappement.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	PSPath, DP

Jeux de paramètres

ByLiteralPath

Position:	Named
Obligatoire:	True
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-NoClobber

Indique 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 indiquer à Export-FormatData de remplacer les fichiers en lecture seule, utilisez le paramètre Force.

Propriétés du paramètre

Type:	SwitchParameter
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	NoOverwrite

Jeux de paramètres

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	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 Force. Pour empêcher le remplacement des fichiers, utilisez le paramètre NoClobber.

Propriétés du paramètre

Type:	String
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False
Alias:	FilePath

Jeux de paramètres

ByPath

Position:	Named
Obligatoire:	True
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

ExtendedTypeDefinition

Vous pouvez acheminer des objets ExtendedTypeDefinition depuis Get-FormatData vers ce cmdlet.

Sorties

None

Cette applet de commande ne retourne aucune sortie. 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, voir about_Execution_Policies.

Liens associés

• Get-FormatData
• Update-FormatData