Partager via

Format-Wide

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

Met en forme des objets en tant que tableau large affichant une seule propriété de chaque objet.

Syntax

Format-Wide
      [[-Property] <Object>]
      [-AutoSize]
      [-Column <int>]
      [-GroupBy <Object>]
      [-View <string>]
       [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <string>]
      [-InputObject <psobject>] 
      [<CommonParameters>]

Description

L’applet Format-Wide de commande met en forme des objets sous la forme d’une table large qui n’affiche qu’une seule propriété de chaque objet. Vous pouvez utiliser le paramètre Property pour déterminer quelle propriété est affichée.

Exemples

Exemple 1 : Mettre en forme les noms des fichiers dans le répertoire actif

Cette commande affiche les noms des fichiers du répertoire actif sous forme de trois colonnes à l'écran.

Get-ChildItem | Format-Wide -Column 3

L’applet Get-ChildItem de commande obtient des objets représentant chaque fichier dans le répertoire. L’opérateur de pipeline (|) transmet les objets de fichier via le pipeline à Format-Wide, qui les met en forme pour la sortie. Le paramètre Column spécifie le nombre de colonnes.

Exemple 2 : Mettre en forme les noms des clés de Registre

Cette commande affiche les noms des clés de Registre dans la HKEY_CURRENT_USER\Software\Microsoft clé.

Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize

L’applet Get-ChildItem de commande obtient des objets représentant les clés. Le chemin d’accès est spécifié sous la forme HKCU:, l’un des lecteurs exposés par le fournisseur PowerShell Registry, suivi du chemin d’accès de la clé. L’opérateur de pipeline (|) transmet les objets de clé de Registre via le pipeline à Format-Wide, qui les met en forme pour la sortie. Le paramètre Property spécifie le nom de la propriété et le paramètre AutoSize ajuste les colonnes pour plus de lisibilité.

Exemple 3 : 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.

PS /> Get-Date | Format-Wide { $_ / $null } -DisplayError


#ERR

PS /> Get-Date | Format-Wide { $_ / $null } -ShowError


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

Paramètres

-AutoSize

Ajuste la taille et le nombre de colonnes en fonction de la largeur des données. Par défaut, la vue détermine la taille et le nombre de colonnes. Vous ne pouvez pas utiliser les paramètres AutoSize et Column dans la même commande.

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

-Column

Spécifie le nombre de colonnes dans l'affichage. Vous ne pouvez pas utiliser les paramètres AutoSize et Column dans la même commande.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayError

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

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

-Expand

Met en forme l'objet de collection, 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 System.Collections.ICollection . La valeur par défaut est EnumOnly.

Les valeurs autorisées sont :

  • EnumOnly: affiche les propriétés des objets de la collection.
  • CoreOnly: affiche les propriétés de l’objet de collection.
  • Both: affiche les propriétés de l’objet de collection et les propriétés des objets de la collection.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indique que cette applet de commande remplace les restrictions qui empêchent la commande de réussir, simplement pour que les modifications ne compromettent pas la sécurité. Par exemple, Force remplace l’attribut de lecture seule ou crée des répertoires pour compléter un chemin d’accès aux fichiers, mais la commande ne tente pas de modifier les autorisations des fichiers.

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

-GroupBy

Formate la sortie dans des groupes basés sur une valeur ou propriété 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. La propriété calculée peut être un bloc de script ou une table de hachage. Les paires clé-valeur valides sont les suivantes :

  • Name (ou Label) - <string>
  • Expression - <string> ou <script block>
  • FormatString - <string>

Pour plus d’informations, consultez about_Calculated_Properties.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Spécifie les objets à mettre en forme. Entrez une variable contenant les objets, ou tapez une commande ou une expression qui obtient ces objets.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Property

Spécifie la propriété d’objet qui apparaît dans l’affichage. 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. La propriété calculée peut être un bloc de script ou une table de hachage. Les paires clé-valeur valides sont les suivantes :

  • Expression - <string> ou <script block>
  • FormatString - <string>

Pour plus d’informations, consultez about_Calculated_Properties.

Type:Object
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

Envoie les erreurs via le pipeline. Ce paramètre est rarement utilisé, mais peut être utilisé comme aide au débogage lorsque vous mettez en forme des expressions dans une Format-Wide commande et que les expressions ne semblent pas fonctionner.

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

-View

Spécifie le nom d’un autre format de table ou d’une vue. Vous ne pouvez pas utiliser les paramètres Property et View dans la même commande.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

PSObject

Vous pouvez diriger n’importe quel objet vers cette applet de commande.

Sorties

Microsoft.PowerShell.Commands.Internal.Format

Cette applet de commande retourne des objets de format qui représentent la table.

Notes

PowerShell inclut les alias suivants pour Format-Wide:

  • Toutes les plateformes :
    • fw

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

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

L’autre vue pour le paramètre View doit utiliser le format table ; si ce n’est pas le cas, la commande échoue. Si l’autre affichage est une liste, utilisez Format-List. Si l’autre vue n’est ni une liste ni une table, utilisez Format-Custom.