Partager via

Update-FormatData

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

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

Syntax

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

Quand Windows PowerShell démarre, il charge les données de mise en forme à partir des fichiers de mise en forme figurant dans le répertoire d'installation de Windows PowerShell ($pshome) de la session. Vous pouvez utiliser Update-FormatData pour recharger les données de mise en forme dans la session active sans redémarrer Windows PowerShell. Cela est utile quand vous avez ajouté ou modifié un fichier de mise en forme et que vous ne voulez pas interrompre la session.

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

Exemples

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

PS C:\> Update-FormatData

Cette commande recharge les fichiers de mise en forme déjà chargés.

Exemple 2 : Recharger les fichiers de mise en forme et les fichiers de mise en forme de trace et de journal

PS C:\> 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

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

# Edit the NewFiles.format.ps1 file.

PS C:\> Update-FormatData

Cet exemple illustre 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 l’avoir 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 Windows PowerShell charge les fichiers de mise en forme intégrés.

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

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

Type:String[]
Aliases:PSPath, Path
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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 Windows PowerShell ne charge les fichiers de mise en forme intégrés.

Pendant la mise en forme des objets .NET, Windows PowerShell utilise la première définition de mise en forme qu'il trouve pour chaque type .NET. Si vous utilisez le paramètre PrependPath, Windows 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 mettant 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
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

String

Vous pouvez diriger une chaîne qui contient le chemin d’ajout vers Update-FormatData.

Sorties

None

L'applet de commande ne retourne aucune sortie.

Notes

  • Update-FormatData met également à jour les données de mise en forme pour les 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 pour les commandes importées. Il est inutile de réimporter le module.