Format-Custom
Utilise un affichage personnalisé 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 Format-Custom
de commande met en forme la sortie d’une commande telle qu’elle est 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 format.ps1xml
fichier et utiliser l’applet Update-FormatData
de commande 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 Start-Transcript
de commande au 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 Update-FormatData
commande 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 Winlogon dans une autre vue personnalisée.
Étant donné que la commande n’utilise pas le paramètre View , Format-Custom
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 Format-Custom
commande 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 :
- ÉnumérationOnly : 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
Indique à l'applet de commande d'afficher toutes les informations sur l'erreur. Utiliser avec les paramètres DisplayError ou ShowError . Par défaut, quand un objet d'erreur est écrit dans les flux d'erreur ou d'affichage, seules certaines informations sur l'erreur s'affichent.
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
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 :
- Nom (ou étiquette)
<string>
- Expression
<string>
ou<script block>
- FormatString
<string>
Pour plus d’informations, consultez 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 contenant les objets, ou tapez une commande ou une expression qui les obtient.
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 elles 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é. La propriété du nom de paramètre est facultative. Vous ne pouvez pas utiliser les paramètres Propriété et Affichage 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, consultez 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 Format-Custom
commande 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 Propriété et Affichage 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
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 tableau, utilisez Format-Table
. Pour afficher une autre vue 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-les Sort-Object
pour les trier.