Partager via

Update-FormatData

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

Met à jour les données de mise en forme dans la session active.

Syntaxe

Update-FormatData
      [[-AppendPath] <String[]>]
      [-PrependPath <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

L’applet de commande Update-FormatData recharge les données de mise en forme des fichiers de mise en forme dans la session active. Cette applet de commande vous permet de mettre à jour les données de mise en forme sans redémarrer PowerShell.

Sans paramètres, Update-FormatData recharge les fichiers de mise en forme qu’il a chargés précédemment. Vous pouvez utiliser les paramètres de Update-FormatData pour ajouter de nouveaux fichiers de mise en forme à la session.

Les fichiers de mise en forme sont des fichiers texte au format XML avec l’extension de nom de fichier format.ps1xml. Les données de mise en forme des fichiers définissent l’affichage des objets Microsoft .NET Framework dans la session.

Au démarrage de PowerShell, il charge les données de format à partir du code source PowerShell. Toutefois, vous pouvez créer des fichiers format.ps1xml personnalisés pour mettre à jour la mise en forme dans la session active. Vous pouvez utiliser Update-FormatData pour recharger les données de mise en forme dans la session active sans redémarrer PowerShell. Cela est utile lorsque vous avez ajouté ou modifié un fichier de mise en forme, mais que vous ne souhaitez pas interrompre la session.

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

Exemples

Exemple 1 : recharger les fichiers de mise en forme précédemment chargés

Update-FormatData

Cette commande recharge les fichiers de mise en forme qu’il a chargés précédemment.

Exemple 2 : recharger les fichiers de mise en forme et les fichiers de suivi et de mise en forme des journaux

Update-FormatData -AppendPath Trace.format.ps1xml, Log.format.ps1xml

Cette commande recharge les fichiers de mise en forme dans la session, y compris deux nouveaux fichiers, Trace.format.ps1xml et Log.format.ps1xml.

Étant donné que la commande utilise le paramètre AppendPath, les données de mise en forme dans les nouveaux fichiers sont chargées après la mise en forme des données des fichiers intégrés.

Le paramètre AppendPath est utilisé, car les nouveaux fichiers contiennent des données de mise en forme pour les objets qui ne sont pas référencés dans les fichiers intégrés.

Exemple 3 : Modifier un fichier de mise en forme et le recharger

Update-FormatData -PrependPath "C:\test\NewFiles.format.ps1xml"

# Edit the NewFiles.format.ps1 file.

Update-FormatData

Cet exemple montre comment recharger un fichier de mise en forme une fois que vous l’avez modifié.

La première commande ajoute le fichier NewFiles.format.ps1xml à la session. Il utilise le paramètre PrependPath, car le fichier contient des données de mise en forme pour les objets référencés dans les fichiers intégrés.

Après avoir ajouté le fichier NewFiles.format.ps1xml et testé dans ces sessions, l’auteur modifie le fichier.

La deuxième commande utilise l’applet de commande Update-FormatData pour recharger les fichiers de mise en forme. Étant donné que le fichier NewFiles.format.ps1xml a été précédemment chargé, Update-FormatData le recharge automatiquement sans utiliser de paramètres.

Paramètres

-AppendPath

Spécifie les fichiers de mise en forme que cette applet de commande ajoute à la session. Les fichiers sont chargés après que PowerShell charge les fichiers de mise en forme intégrés.

Lors de la mise en forme d’objets .NET, PowerShell utilise la première définition de mise en forme qu’elle trouve pour chaque type .NET. Si vous utilisez le paramètre AppendPath, PowerShell recherche les données à partir des fichiers intégrés avant de rencontrer les données de mise en forme que vous ajoutez.

Utilisez ce paramètre pour ajouter un fichier qui met en forme un objet .NET qui n’est pas référencé dans les fichiers de mise en forme intégrés.

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

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

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

-PrependPath

Spécifie les fichiers de mise en forme que cette applet de commande ajoute à la session. Les fichiers sont chargés avant que PowerShell charge les fichiers de mise en forme intégrés.

Lors de la mise en forme d’objets .NET, PowerShell utilise la première définition de mise en forme qu’elle trouve pour chaque type .NET. Si vous utilisez le paramètre PrependPath, PowerShell recherche les données des fichiers que vous ajoutez avant de rencontrer les données de mise en forme des fichiers intégrés.

Utilisez ce paramètre pour ajouter un fichier qui met en forme un objet .NET qui est également référencé dans les fichiers de mise en forme intégrés.

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

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

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

Entrées

String

Vous pouvez diriger une chaîne qui contient le chemin d’accès d’ajout à cette applet de commande.

Sorties

None

Cette applet de commande ne retourne aucune sortie.

Notes

  • Update-FormatData met également à jour les données de mise en forme des commandes de la session qui ont été importées à partir de modules. Si le fichier de mise en forme d’un module change, vous pouvez exécuter une commande Update-FormatData pour mettre à jour les données de mise en forme des commandes importées. Vous n’avez pas besoin d’importer à nouveau le module.