Partager via

Format-List

Module:
Microsoft.PowerShell.Utility Module

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

Syntaxe

Default (Par défaut) 

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

Description

L’applet de commande Format-List met en forme la sortie d’une commande sous la forme d’une 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 sélectionnées d’un objet en tant que liste (format-list *).

Étant donné que plus d’espace est disponible pour chaque élément d’une liste que dans une table, PowerShell affiche plus de propriétés de l’objet dans la liste et les valeurs de propriété sont moins susceptibles d’être tronquées.

Exemples

Exemple 1 : Mettre en forme les services d’ordinateur

Get-Service | Format-List

Cette commande met en forme des informations sur les services sur l’ordinateur sous forme de liste. Par défaut, les services sont mis en forme sous forme de tableau. L’applet de commande Get-Service obtient des objets représentant les services sur l’ordinateur. L’opérateur de pipeline (|) transmet les résultats via le pipeline à Format-List. Ensuite, la commande Format-List met en forme les informations de service dans une liste et l’envoie à l’applet de commande de sortie par défaut pour l’affichage.

Exemple 2 : Mettre en forme des fichiers PS1XML

Ces commandes affichent des informations sur les fichiers PS1XML dans le répertoire PowerShell sous forme de liste.

$A = Get-ChildItem $pshome\*.ps1xml
Format-List -InputObject $A

La première commande obtient les objets représentant les fichiers et les stocke dans la variable $A.

La deuxième commande utilise Format-List pour mettre en forme des informations sur les objets stockés dans $A. Cette commande utilise le paramètre InputObject pour passer la variable à , qui envoie ensuite la sortie mise en forme à l’applet de commande de sortie par défaut pour l’affichage.

Exemple 3 : Mettre en forme les propriétés du processus par nom

Cette commande affiche le nom, la priorité de base et la classe de priorité de chaque processus sur l’ordinateur.

Get-Process | Format-List -Property name, basepriority, priorityclass

Il utilise l’applet de commande Get-Process pour obtenir un objet représentant chaque processus. L’opérateur de pipeline (|) transmet les objets de processus via le 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 du paramètre Property est facultatif. Vous pouvez donc l’omettre.

Exemple 4 : Mettre en forme toutes les propriétés d’un processus

Cette commande affiche toutes les propriétés du processus Winlogon.

Get-Process winlogon | Format-List -Property *

Il utilise l’applet de commande Get-Process pour obtenir un objet représentant le processus Winlogon. L’opérateur de pipeline (|) transmet l’objet de processus Winlogon via le pipeline à Format-List. La commande utilise le paramètre Property pour spécifier les propriétés et le * pour indiquer toutes les propriétés. Étant donné que le nom du paramètre propriété est facultatif, vous pouvez l’omettre et taper la commande en tant que . Format-List envoie automatiquement les résultats à l’applet de commande de sortie par défaut pour l’affichage.

Exemple 5 : Résolution des erreurs de format

Les exemples suivants montrent les résultats de l’ajout des paramètres DisplayError ou ShowError avec une expression.

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -DisplayError

DayOfWeek    : Friday
 $_ / $null  : #ERR

PC /> Get-Date | Format-List DayOfWeek,{ $_ / $null } -ShowError

DayOfWeek    : Friday
 $_ / $null  :

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 7:59:23 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Paramètres

-DisplayError

Indique que cette applet de commande affiche des erreurs sur la ligne de commande. Ce paramètre est rarement utilisé, mais peut être utilisé comme aide de débogage lorsque vous mettez en forme des expressions dans une commande Format-List et que les expressions ne semblent pas fonctionner.

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

-Expand

Spécifie l’objet de collection mis en forme, ainsi que les objets de 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 acceptables pour ce paramètre sont les suivantes :

  • EnumOnly. Affiche les propriétés des objets de la collection.
  • Noyau uniquement. Affiche les propriétés de l’objet de collection.
  • Les deux. Affiche les propriétés de l’objet de collection et les propriétés des objets de la collection.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Valeurs acceptées:CoreOnly, EnumOnly, Both
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

-Force

Indique que cette applet de commande affiche toutes les informations d’erreur. Utilisez le paramètre "DisplayError" ou "ShowError". Par défaut, lorsqu’un objet d’erreur est écrit dans les flux d’erreur ou d’affichage, seules certaines informations d’erreur sont affichées.

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

-GroupBy

Spécifie la sortie dans les groupes en fonction d’une propriété ou d’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 les suivantes :

  • Nom (ou Étiquette) <chaîne>
  • < de bloc de script >chaîne< ou >
  • FormatString <chaîne>

Propriétés du paramètre

Type:Object
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 à mettre en forme. Entrez une variable qui contient les objets ou tapez une commande ou une expression qui obtient les objets.

Propriétés du paramètre

Type:PSObject
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:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Property

Spécifie les propriétés d’objet qui apparaissent dans l’affichage et l’ordre dans lequel ils apparaissent. Les caractères génériques sont autorisés.

Si vous omettez ce paramètre, les propriétés qui apparaissent dans l’affichage dépendent de l’objet affiché. Le nom du 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 les suivantes :

  • Nom (ou Étiquette) <chaîne>
  • < de bloc de script >chaîne< ou >
  • FormatString <chaîne>

Propriétés du paramètre

Type:

Object[]

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

Jeux de paramètres

(All)
Position:0
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ShowError

Indique que la cmdlet envoie des erreurs par l'intermédiaire du pipeline. Ce paramètre est rarement utilisé, mais peut être utilisé comme aide de débogage lorsque vous mettez en forme des expressions dans une commande Format-List et que les expressions ne semblent pas fonctionner.

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

-View

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.

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

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

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

PSObject

Vous pouvez diriger n’importe quel objet vers Format-List.

Sorties

Microsoft.PowerShell.Commands.Internal.Format

Format-List retourne les objets de format qui représentent la liste.

Notes

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 format, telles que Format-List, organisent les données devant être affichées, mais ne les affichent pas. Les données sont affichées par les fonctionnalités de sortie de PowerShell et par les applets de commande qui contiennent le verbe Out (applets de commande Out), telles que Out-Host ou Out-File.

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

Le paramètre GroupBy suppose que les objets sont triés. Utilisez Sort-Object avant d’utiliser Format-List pour regrouper les objets.

Le paramètre View vous permet de spécifier un autre format pour le tableau. Vous pouvez utiliser les vues définies dans les fichiers *.format.PS1XML dans le répertoire PowerShell, ou vous pouvez créer vos propres vues dans de nouveaux fichiers PS1XML et utiliser l’applet de commande Update-FormatData pour les inclure dans PowerShell.

L’autre affichage du paramètre View doit utiliser le format de liste ; sinon, la commande échoue. Si l’autre vue est une table, utilisez Format-Table. Si l’affichage de remplacement n’est pas une liste ou une table, utilisez Format-Custom.