Utilise un affichage personnalisé pour mettre en forme la sortie.
Syntaxe
Format-Custom [[-Property] <Object[]>] [-Depth <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
Description
L'applet de commande Format-Custom met en forme la sortie d'une commande comme défini dans un autre affichage. Format-Custom est conçue pour afficher des vues qui ne sont pas simplement des tableaux ou des listes. Vous pouvez utiliser les affichages définis dans les fichiers *format.PS1XML du répertoire Windows PowerShell ou vous pouvez créer vos propres affichages dans de nouveaux fichiers PS1XML et utiliser l'applet de commande Update-FormatData pour les ajouter à Windows PowerShell.
Paramètres
-Depth <int>
Spécifie le nombre de colonnes dans l'affichage.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-DisplayError
Affiche les erreurs à la ligne de commande.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Expand <string>
Met en forme l'objet de collection, ainsi que les objets dans la collection. Ce paramètre est conçu pour mettre en forme des objets qui prennent en charge l'interface ICollection (System.Collections). La valeur par défaut est EnumOnly.
Les valeurs valides sont :
-- EnumOnly : affiche les propriétés des objets dans la collection.
-- CoreOnly : affiche les propriétés de l'objet collection.
-- Both : affiche les propriétés de l'objet collection et les propriétés des objets de la collection.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Force
Demande à l'applet de commande d'afficher toutes les informations relatives à l'erreur. Utilisez ce paramètre avec les paramètres DisplayError ou ShowError. Par défaut, quand un objet erreur est écrit dans les flux d'erreurs ou d'affichages, seule une partie des informations relatives à l'erreur s'affiche.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-GroupBy <Object>
Met en forme la sortie dans les groupes selon une propriété ou une valeur partagée. Entrez une expression ou une propriété de la sortie.
La valeur du paramètre GroupBy peut être une nouvelle propriété calculée. Pour créer une propriété calculée, utilisez une table de hachage. Les clés valides sont :
-- Name (ou Label) <chaîne>
-- Expression <chaîne> ou <bloc de script>
-- FormatString <chaîne>
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-InputObject <psobject>
Spécifie les objets à mettre en forme. Entrez une variable contenant les objets ou tapez une commande ou une expression qui obtient les objets.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByValue) |
|
Accepter les caractères génériques ? |
false |
-Property <Object[]>
Spécifie les propriétés d'objet qui apparaissent dans l'affichage et l'ordre dans lesquels elles apparaissent. Les caractères génériques sont autorisés.
Sans ce paramètre, les propriétés qui apparaissent dans l'affichage dépendent de l'objet qui est affiché. Le nom de paramètre (« Property ») est facultatif. Vous ne pouvez pas utiliser les paramètres Property et View dans la même commande.
La valeur du paramètre Property peut être une nouvelle propriété calculée. Pour créer une propriété calculée, utilisez une table de hachage. Les clés valides sont :
-- Expression <chaîne> ou <bloc de script>
-- Depth <int32>
|
Obligatoire ? |
false |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-ShowError
Envoie des erreurs le long du pipeline.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-View <string>
Spécifie le nom d'un autre format ou « vue ». Si vous omettez ce paramètre, Format-Custom utilise une vue personnalisée par défaut. Vous ne pouvez pas utiliser les paramètres Property et View dans la même commande.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
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.PSObject Vous pouvez diriger n'importe quel objet vers Format-Custom. |
|
Sorties |
Microsoft.PowerShell.Commands.Internal.Format Format-Custom retourne les objets de mise en forme qui représentent l'affichage. |
Remarques
Format-Custom est conçue pour afficher des vues qui ne sont pas seulement des tableaux ou des listes. Pour afficher une autre vue sous forme de tableau, utilisez Format-Table. Pour afficher une autre vue sous forme de liste, utilisez Format-List.
Vous pouvez également faire référence à Format-Custom par son alias intégré, « fc ». Pour plus d'informations, consultez about_Aliases.
Le paramètre GroupBy suppose que les objets sont triés. Avant d'utiliser Format-Custom pour grouper les objets, utilisez Sort-Object pour les trier.
Exemple 1
C:\PS>get-command start-transcript | format-custom -view MyView Description ----------- Cette commande met en forme les informations concernant l'applet de commande Start-Transcript selon le format défini par l'affichage MyView, un affichage personnalisé créé par l'utilisateur. Pour exécuter cette commande correctement, vous devez d'abord créer un fichier PS1XML, définir l'affichage MyView, puis utiliser la commande Update-FormatData pour ajouter le fichier PS1XML à Windows PowerShell.
Exemple 2
C:\PS>get-process Winlogon | format-custom Description ----------- Cette commande met en forme les informations sur le processus Winlogon dans un autre affichage personnalisé. Dans la mesure où la commande n'utilise pas le paramètre View, Format-Custom utilise un affichage personnalisé par défaut pour mettre en forme les données.