Format-Custom

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Verwendet eine benutzerdefinierte Ansicht zur Formatierung der Ausgabe.

Syntax

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

Beschreibung

Das Format-Custom Cmdlet formatiert die Ausgabe eines Befehls, wie in einer alternativen Ansicht definiert. Format-Custom ist so konzipiert, dass Ansichten angezeigt werden, 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 Update-FormatData Cmdlet verwenden, um sie zu PowerShell hinzuzufügen.

Beispiele

Beispiel 1: Formatieren der Ausgabe mit einer benutzerdefinierten Ansicht

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

Mit diesem Befehl werden Informationen zum Start-Transcript Cmdlet im von der MyView-Ansicht definierten Format formatiert, einer vom Benutzer erstellten benutzerdefinierten Ansicht. Um diesen Befehl erfolgreich auszuführen, müssen Sie zuerst eine neue PS1XML-Datei erstellen, die MyView-Ansicht definieren und dann den Update-FormatData Befehl verwenden, um die PS1XML-Datei zu PowerShell hinzuzufügen.

Beispiel 2: Formatieren der Ausgabe mit der Standardansicht

Get-Process Winlogon | Format-Custom

Dieser Befehl formatiert Informationen zum Winlogon-Prozess in einer alternativen angepassten Ansicht. Da der Befehl den Parameter "View" nicht verwendet, Format-Custom wird zum Formatieren der Daten eine benutzerdefinierte Standardansicht verwendet.

Beispiel 3: Problembehandlung bei Formatfehlern

Die folgenden Beispiele zeigen die Ergebnisse des Hinzufügens der DisplayError - oder ShowError-Parameter mit einem Ausdruck.

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 in 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 Auflistungsobjekts 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

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

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

-GroupBy

Formatiert die Ausgabe basierend auf einer freigegebenen Eigenschaft bzw. einem freigegebenen Wert in Gruppen. Geben Sie einen Ausdruck oder eine Eigenschaft der Ausgabe ein.

Der Wert des GroupBy-Parameters 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

Gibt die in der Anzeige angezeigten Objekteigenschaften und die Reihenfolge an, in der sie angezeigt werden. Platzhalter sind zulässig.

Wenn Sie diesen Parameter weglassen, hängen die in der Anzeige dargestellten Eigenschaften von dem angezeigten Objekt ab. Der Parametername -Eigenschaft 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, Format-Custom wird eine benutzerdefinierte Standardansicht verwendet. 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 ist so konzipiert, dass Ansichten angezeigt werden, die nicht nur Tabellen oder nur Listen sind. Verwenden Sie Format-Tablezum Anzeigen einer alternativen Tabellenansicht . Um eine alternative Listenansicht anzuzeigen, verwenden Sie Format-List.

Der Parameter GroupBy geht davon aus, dass die Objekte sortiert sind. Format-Custom Bevor Sie die Objekte gruppieren, können Sort-Object Sie sie sortieren.