Freigeben über

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 dient zum Anzeigen von Ansichten, die nicht nur Tabellen oder nur Listen sind. Sie können die im *-Format definierten Ansichten verwenden. PS1XML-Dateien im PowerShell-Verzeichnis oder Sie können Ihre eigenen Ansichten in neuen PS1XML-Dateien erstellen und das Cmdlet Update-FormatData 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 wird, einer vom Benutzer erstellten benutzerdefinierten Ansicht. Um diesen Befehl erfolgreich auszuführen, müssen Sie zunächst 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 die Informationen über den Winlogon-Prozess in einer alternativen benutzerdefinierten Ansicht. Da der Befehl den View-Parameter nicht verwendet, Format-Custom verwendet eine benutzerdefinierte Standardansicht zum Formatieren der Daten.

Beispiel 3: Problembehandlung bei Formatfehlern

Die folgenden Beispiele zeigen die Ergebnisse des Hinzufügens des DisplayError- oder ShowError-Parameters 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 scheinbar nicht 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 dient zum Formatieren der Objekte, die die ICollection (System.Collections)-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 Eigenschaften von Objekten 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 neu berechnete Eigenschaft sein. Zum Erstellen einer berechneten Eigenschaft verwenden Sie eine Hashtabelle. Gültige Schlüssel sind:

  • Namenszeichenfolge (oder Bezeichnung) <>
  • Ausdruckszeichenfolge <> oder <Skriptblock>
  • FormatString-Zeichenfolge <>
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. Der Parametername („Property“) ist optional. Sie können die Parameter Property und View nicht im gleichen Befehl verwenden.

Der Wert des Property-Parameters kann eine neu berechnete Eigenschaft sein. Zum Erstellen einer berechneten Eigenschaft verwenden Sie eine Hashtabelle. Gültige Schlüssel sind:

  • Ausdruckszeichenfolge <> oder <Skriptblock>
  • Tiefe <int32>
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 scheinbar nicht 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 "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 Format-Custom übergeben.

Ausgaben

Microsoft.PowerShell.Commands.Internal.Format

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

Hinweise

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.

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

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