Format-List

Met en forme la sortie en tant que liste de propriétés dans laquelle chaque propriété apparaît sur une nouvelle ligne.

Syntaxe

Format-List [[-Property] <Object[]>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]

Description

L'applet de commande Format-List met en forme la sortie d'une commande en tant que liste de propriétés dans laquelle chaque propriété est affichée sur une ligne distincte. Vous pouvez utiliser Format-List pour mettre en forme et afficher toutes les propriétés ou les propriétés sélectionnées d'un objet sous la forme d'une liste (format-list *).

Dans la mesure où chaque élément dispose de plus d'espace dans une liste que dans un tableau, Windows PowerShell affiche plus de propriétés de l'objet dans la liste, et il est moins probable que les valeurs de propriété soient tronquées.

Paramètres

-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 <string> 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 :

-- Name (ou Label) <chaîne>

-- Expression <chaîne> ou <bloc de script>

-- FormatString <chaîne>

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 de liste ou « vue ». 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-List.
Sorties	Microsoft.PowerShell.Commands.Internal.Format Format-List retourne les objets de mise en forme qui représentent la liste.

Remarques

Vous pouvez également faire référence à Format-List par son alias intégré, « FL ». Pour plus d'informations, consultez about_Aliases.

Les applets de commande de mise en forme, telles que Format-List, réorganisent les données à afficher, mais ne les affichent pas. Les données sont affichées par les fonctionnalités de sortie de Windows PowerShell, et par les applets de commande contenant le verbe Out ( les applets de commande Out), telles que Out-Host, Out-File et Out-Printer.

Si vous n'utilisez pas d'applet de commande de format, Windows PowerShell applique le format par défaut pour chaque objet qu'il affiche.

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.

Le paramètre View permet de spécifier un autre format pour le tableau. 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 inclure dans Windows PowerShell.

L'autre affichage du paramètre View doit utiliser le format de liste ; autrement, la commande échoue. Si l'autre affichage est un tableau, utilisez Format-Table. Si l'autre affichage n'est ni une liste ni un tableau, utilisez Format-Custom.

Exemple 1

C:\PS>get-service | format-list

Description
-----------
Cette commande met au format liste les informations sur les services de l'ordinateur. Par défaut, les services sont au format tableau. L'applet de commande Get-Service obtient les objets qui représentent les services sur l'ordinateur. L'opérateur de pipeline (|) passe les résultats le long du pipeline à Format-List. Ensuite, la commande Format-List met en forme les informations de service sous forme de liste et les envoie à l'applet de commande de sortie par défaut pour affichage.

Exemple 2

C:\PS>$a = get-childitem $pshome\*.ps1xml

Description
-----------
Ces commandes affichent au format liste les informations sur les fichiers PS1XML dans le répertoire Windows PowerShell. La première commande obtient les objets qui représentent les fichiers et les stocke dans la variable $a. La deuxième commande utilise Format-List pour mettre en forme les informations sur les objets stockés dans la variable $a. Elle utilise le paramètre InputObject pour passer la variable à Format-List, qui envoie ensuite la sortie mise en forme à l'applet de commande de sortie par défaut pour affichage.

Exemple 3

C:\PS>get-process | format-list -property name, basepriority, priorityclass

Description
-----------
Cette commande affiche le nom, la priorité de base et la classe de priorité de chaque processus sur l'ordinateur. Elle utilise l'applet de commande Get-Process pour obtenir un objet qui représente chaque processus. L'opérateur de pipeline (|) passe les objets processus le long du pipeline à Format-List. Format-List met en forme les processus sous la forme d'une liste des propriétés spécifiées. Le nom de paramètre « Property » étant facultatif, vous pouvez l'omettre.

Exemple 4

C:\PS>get-process winlogon | format-list -property *

Description
-----------
Cette commande affiche toutes les propriétés du processus Winlogon. Elle utilise l'applet de commande Get-Process pour obtenir un objet qui représente le processus Winlogon. L'opérateur de pipeline (|) passe l'objet processus Winlogon le long du pipeline à Format-List. La commande utilise le paramètre Property pour spécifier les propriétés et * indique toutes les propriétés. Étant donné que le nom du paramètre Property est facultatif, vous pouvez l'omettre et taper la commande comme suit : « format-list * ». Format-List envoie automatiquement les résultats à l'applet de commande de sortie par défaut pour affichage.