Partager via

Format-Custom

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

Utilise une vue personnalisée pour mettre en forme la sortie.

Syntaxe

Format-Custom
      [[-Property] <Object[]>]
      [-Depth <Int32>]
      [-GroupBy <Object>]
      [-View <String>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <String>]
      [-InputObject <PSObject>]
      [<CommonParameters>]

Description

L’applet de commande Format-Custom met en forme la sortie d’une commande telle que définie dans une autre vue. Format-Custom est conçu pour afficher des vues qui ne sont pas seulement des tables ou des listes. Vous pouvez utiliser les vues définies dans PowerShell, ou vous pouvez créer vos propres vues dans un nouveau fichier format.ps1xml et utiliser l’applet de commande Update-FormatData pour les ajouter à PowerShell.

Exemples

Exemple 1 : Mettre en forme la sortie avec une vue personnalisée

Get-Command Start-Transcript | Format-Custom -View MyView

Cette commande met en forme des informations sur l’applet de commande Start-Transcript dans le format défini par la vue MyView, une vue personnalisée créée par l’utilisateur. Pour exécuter cette commande, vous devez d’abord créer un fichier PS1XML, définir la vue MyView, puis utiliser la commande Update-FormatData pour ajouter le fichier PS1XML à PowerShell.

Exemple 2 : Mettre en forme la sortie avec la vue par défaut

Get-Process Winlogon | Format-Custom

Cette commande met en forme des informations sur le processus de Winlogon dans une autre vue personnalisée. Étant donné que la commande n’utilise pas le paramètre View, utilise une vue personnalisée par défaut pour mettre en forme les données.

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.

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

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  = #ERR
}


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

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  =
}

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

Paramètres

-Depth

Spécifie le nombre de colonnes dans l’affichage.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DisplayError

Affiche les 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-Custom et que les expressions ne semblent pas fonctionner.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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 valides sont les suivantes :

  • EnumOnly : affiche les propriétés des objets de la collection.
  • CoreOnly : affiche les propriétés de l’objet de collection.
  • Les deux : affiche les propriétés de l’objet de collection et les objets de la collection.
Type:String
Valeurs acceptées:CoreOnly, EnumOnly, Both
Position:Named
Valeur par défaut:EnumOnly
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Force

Dirige l’applet de commande pour afficher toutes les informations d’erreur. Utilisez les paramètres 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.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-GroupBy

Met en forme 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. Le paramètre GroupBy s’attend à ce que les objets soient triés. Utilisez l’applet de commande Sort-Object avant d’utiliser Format-Custom pour regrouper les objets.

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 :

  • Nom (ou étiquette) <string>
  • Expression <string> ou <script block>
  • FormatString <string>

Pour plus d'informations, voir about_Calculated_Properties.

Type:Object
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:PSObject
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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. 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>
  • Profondeur - <int32>

Pour plus d'informations, voir about_Calculated_Properties.

Type:Object[]
Position:0
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-ShowError

Envoie les erreurs via le 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-Custom et que les expressions ne semblent pas fonctionner.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-View

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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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 les objets de format qui représentent l’affichage.

Notes

Windows PowerShell inclut les alias suivants pour Format-Custom:

  • fc

Format-Custom est conçu pour afficher des vues qui ne sont pas seulement des tables ou des listes. Pour afficher une autre vue de table, utilisez Format-Table. Pour afficher un autre affichage de liste, utilisez Format-List.

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