Freigeben über

Format-Custom

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Verwendet eine angepasste Ansicht, um die Ausgabe zu formatieren.

Syntax

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

Beschreibung

Das Cmdlet Format-Custom formatiert die Ausgabe eines Befehls wie in einer alternativen Ansicht definiert. Format-Custom dient zum Anzeigen von Ansichten, die nicht nur Tabellen oder nur Listen sind. Sie können die in PowerShell definierten Ansichten verwenden oder eigene Ansichten in einer neuen format.ps1xml Datei erstellen und das cmdlet Update-FormatData verwenden, um sie zu PowerShell hinzuzufügen.

Beispiele

Beispiel 1: Ausgabe mit einer angepassten Ansicht formatieren

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

Mit diesem Befehl werden Informationen zum Cmdlet Start-Transcript im Format dargestellt, das durch die MyView-Ansicht definiert wurde — eine benutzerdefinierte Ansicht, die vom Nutzer erstellt wurde. Um diesen Befehl erfolgreich auszuführen, müssen Sie zuerst eine neue PS1XML-Datei erstellen, die MyView--Ansicht definieren und dann den befehl Update-FormatData verwenden, um die PS1XML-Datei zu PowerShell hinzuzufügen.

Beispiel 2: Ausgabe formatieren mit Standardansicht

Get-Process Winlogon | Format-Custom

Dieser Befehl formatiert Informationen über den Prozess Winlogon in einer alternativen, angepassten Ansicht. Da der Befehl den Parameter View nicht verwendet, verwendet Format-Custom eine benutzerdefinierte Standardansicht, um die Daten zu formatieren.

Beispiel 3: Problembehandlung bei Formatfehlern

Die folgenden Beispiele zeigen die Ergebnisse, wenn Sie die Parameter DisplayError oder ShowError mit einem Ausdruck hinzufügen.

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

Parameter

-Depth

Gibt die Anzahl der Spalten in der Anzeige an.

Typ:Int32
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-DisplayError

Zeigt Fehler an der Befehlszeile an. Dieser Parameter wird selten verwendet, kann aber als Debugginghilfe verwendet werden, wenn Sie Ausdrücke in einem Format-Custom Befehl formatieren, und die Ausdrücke scheinen nicht zu funktionieren.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Expand

Formatiert das Auflistungsobjekt und die Objekte in der Auflistung. Dieser Parameter wurde entwickelt, um Objekte zu formatieren, die die System.Collections.ICollection Schnittstelle unterstützen. Der Standardwert ist EnumOnly.

Gültige Werte sind:

  • EnumOnly: Zeigt die Eigenschaften der Objekte in der Auflistung an.
  • CoreOnly: Zeigt die Eigenschaften des Sammlungsobjekts an.
  • Beides: Zeigt die Eigenschaften des Auflistungsobjekts und die Objekte in der Auflistung an.
Typ:String
Zulässige Werte:CoreOnly, EnumOnly, Both
Position:Named
Standardwert:EnumOnly
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

Leitet das Cmdlet an, um alle Fehlerinformationen anzuzeigen. Wird mit den Parametern DisplayError oder ShowError verwendet. Wenn ein Fehlerobjekt standardmäßig in den Fehler- oder Anzeigedatenstrom geschrieben wird, werden nur einige der Fehlerinformationen angezeigt.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-GroupBy

Formatiert die Ausgabe in Gruppen basierend auf einer gemeinsamen Eigenschaft oder einem gemeinsamen Wert. Geben Sie einen Ausdruck oder eine Eigenschaft der Ausgabe ein. Der parameter GroupBy erwartet, dass die Objekte sortiert werden. Verwenden Sie das Cmdlet Sort-Object, bevor Sie Format-Custom verwenden, um die Objekte zu gruppieren.

Der Wert des parameters GroupBy kann eine neue berechnete Eigenschaft sein. Die berechnete Eigenschaft kann ein Skriptblock oder eine Hashtabelle sein. Gültige Schlüsselwertpaare sind:

  • Name (oder Bezeichnung) – <string>
  • Ausdruck – <string> oder <script block>
  • FormatString – <string>

Weitere Informationen finden Sie unter about_Calculated_Properties.

Typ:Object
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-InputObject

Gibt die zu formatierenden Objekte an. Geben Sie eine Variable ein, die die Objekte enthält, oder geben Sie einen Befehl oder einen Ausdruck ein, durch den die Objekte abgerufen werden.

Typ:PSObject
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Property

Legt die Objekteigenschaften fest, die in der Anzeige erscheinen, sowie die Reihenfolge ihres Erscheinens. Platzhalter sind zulässig.

Wenn Sie diesen Parameter weglassen, hängen die eigenschaften, die in der Anzeige angezeigt werden, vom angezeigten Objekt ab. Der Parametername Property ist optional. Sie können die Parameter Property und View nicht im selben Befehl verwenden.

Der Wert des Property-Parameters kann eine neue berechnete Eigenschaft sein. Die berechnete Eigenschaft kann ein Skriptblock oder eine Hashtabelle sein. Gültige Schlüsselwertpaare sind:

  • Ausdruck – <string> oder <script block>
  • Tiefe – <int32>

Weitere Informationen finden Sie unter about_Calculated_Properties.

Typ:Object[]
Position:0
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

-ShowError

Sendet Fehler über die Pipeline. Dieser Parameter wird selten verwendet, kann aber als Debugginghilfe verwendet werden, wenn Sie Ausdrücke in einem Format-Custom Befehl formatieren, und die Ausdrücke scheinen nicht zu funktionieren.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-View

Gibt den Namen eines alternativen Formats oder einer anderen Ansicht an. Wenn Sie diesen Parameter weglassen, verwendet Format-Custom eine benutzerdefinierte Standardansicht. Sie können die Parameter Property und View nicht im selben Befehl verwenden.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

PSObject

Sie können jedes Objekt an dieses Cmdlet weiterleiten.

Ausgaben

Microsoft.PowerShell.Commands.Internal.Format

Dieses Cmdlet gibt die Formatobjekte zurück, die die Anzeige darstellen.

Hinweise

PowerShell enthält die folgenden Aliase für Format-Custom:

  • Alle Plattformen:
    • fc

Format-Custom dient zum Anzeigen von Ansichten, die nicht nur Tabellen oder nur Listen sind. Verwenden Sie Format-Table, um eine alternative Tabellenansicht anzuzeigen. Verwenden Sie Format-List, um eine alternative Listenansicht anzuzeigen.

Der parameter GroupBy geht davon aus, dass die Objekte sortiert sind. Bevor Sie Format-Custom zum Gruppieren der Objekte verwenden, verwenden Sie Sort-Object, um sie zu sortieren.