Share via

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 zum Anzeigen von Ansichten konzipiert, die nicht nur Tabellen oder nur Listen sind. Sie können die in PowerShell definierten Ansichten verwenden oder Ihre eigenen Ansichten in einer neuen format.ps1xml Datei erstellen und das Update-FormatData Cmdlet verwenden, um sie PowerShell hinzuzufügen.

Beispiele

Beispiel 1: Formatieren der Ausgabe mit einer benutzerdefinierten Ansicht

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

Dieser Befehl formatiert Informationen über das Start-Transcript Cmdlet in dem Format, das von der MyView-Ansicht definiert ist, einer benutzerdefinierten Ansicht, die vom Benutzer erstellt wurde. 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 benutzerdefinierten Ansicht. Da der Befehl den View-Parameter nicht verwendet, Format-Custom verwendet eine benutzerdefinierte Standardansicht, um die Daten zu formatieren.

Beispiel 3: Problembehandlung bei Formatfehlern

Die folgenden Beispiele zeigen die Ergebnisse des Hinzufügens der Parameter DisplayError oder ShowError 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.

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

-DisplayError

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

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

-Expand

Formatiert das Auflistungsobjekt und die Objekte in der Auflistung. Dieser Parameter ist zum Formatieren von Objekten konzipiert, 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 der Objekte in der Auflistung an.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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üssel-Wert-Paare sind:

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

Weitere Informationen finden Sie unter about_Calculated_Properties.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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. Die Parametername-Eigenschaft ist optional. Sie können die Parameter Property und View nicht im gleichen 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üssel-Wert-Paare sind:

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

Weitere Informationen finden Sie unter about_Calculated_Properties.

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

-ShowError

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 gleichen Befehl verwenden.

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

Eingaben

PSObject

Sie können jedes Objekt an übergeben Format-Custom.

Ausgaben

Microsoft.PowerShell.Commands.Internal.Format

Format-Custom gibt die Formatobjekte zurück, die die Anzeige darstellen.

Hinweise

Format-Custom ist zum Anzeigen von Ansichten konzipiert, die nicht nur Tabellen oder nur Listen sind. Verwenden Sie Format-Tablezum Anzeigen einer alternativen Tabellenansicht . Verwenden Sie Format-Listzum Anzeigen einer alternativen Listenansicht .

Sie können auch auf den Format-Custom integrierten Alias verweisen. fc Weitere Informationen finden Sie unter about_Aliases.

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