Formatiert die Ausgabe mithilfe einer benutzerdefinierten Ansicht.
Syntax
Format-Custom [[-Eigenschaft] <Object[]>] [-Depth <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
Beschreibung
Das Cmdlet "Format-Custom" formatiert die Ausgabe eines Befehls so, wie in einer alternativen Ansicht definiert. Format-Custom ist für die Anzeige von Ansichten vorgesehen, bei denen es sich nicht lediglich um Tabellen oder Listen handelt. Sie können die in den *.FORMAT.PS1XML-Dateien im Windows PowerShell-Verzeichnis definierten Ansichten verwenden oder eigene Ansichten in neuen PS1XML-Dateien erstellen und sie Windows PowerShell mit dem Cmdlet "Update-FormatData" hinzufügen.
Parameter
-Depth <int>
Gibt die Anzahl der Spalten in der Anzeige an.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-DisplayError
Zeigt Fehler in der Befehlszeile an.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-Expand <string>
Formatiert das Auflistungsobjekt sowie die Objekte in der Auflistung. Mit diesem Parameter werden Objekte formatiert, die die ICollection-Schnittstelle (System.Collections) unterstützen. Der Standardwert ist "EnumOnly".
Gültige Werte:
– EnumOnly: Zeigt die Eigenschaften der Objekte in der Auflistung an.
– CoreOnly: Zeigt die Eigenschaften des Auflistungsobjekts an.
– Both: Zeigt die Eigenschaften des Auflistungsobjekts und die Eigenschaften der Objekte in der Auflistung an.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-Force
Weist das Cmdlet an, alle Fehlerinformationen anzuzeigen. Wird mit dem DisplayError-Parameter oder dem ShowError-Parameter verwendet. Wenn ein Fehlerobjekt in die Fehler- oder Anzeigestreams geschrieben wird, werden standardmäßig nur einige der Fehlerinformationen angezeigt.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-GroupBy <Object>
Formatiert die Ausgabe anhand einer freigegebenen Eigenschaft oder eines freigegebenen Werts in Gruppen. Geben Sie einen Ausdruck oder eine Eigenschaft der Ausgabe ein.
Bei dem Wert des GroupBy-Parameters kann es sich um eine neu berechnete Eigenschaft handeln. Verwenden Sie zum Erstellen einer berechneten Eigenschaft eine Hashtabelle. Gültige Schlüssel sind:
– Name (oder Label) <Zeichenfolge>
– Expression <Zeichenfolge> oder <Skriptblock>
– FormatString <Zeichenfolge>
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-InputObject <psobject>
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, mit dem die Objekte abgerufen werden.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
true (ByValue) |
|
Platzhalterzeichen akzeptieren? |
false |
-Eigenschaft <Object[]>
Gibt die Objekteigenschaften an, die angezeigt werden, sowie die Reihenfolge ihrer Anzeige. Platzhalter sind zulässig.
Wenn Sie diesen Parameter auslassen, hängen die angezeigten Eigenschaften vom angezeigten Objekt ab. Der Parametername ("Property") ist optional. Sie können den Property-Parameter nicht zusammen mit dem View-Parameter in einem Befehl verwenden.
Bei dem Wert des Property-Parameters kann es sich um eine neu berechnete Eigenschaft handeln. Verwenden Sie zum Erstellen einer berechneten Eigenschaft eine Hashtabelle. Gültige Schlüssel sind:
– Expression <Zeichenfolge> oder <Skriptblock>
– Depth <int32>
|
Erforderlich? |
false |
|
Position? |
1 |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-ShowError
Übergibt Fehler über die Pipeline.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-View <string>
Gibt den Namen eines alternativen Formats bzw. einer alternativen Ansicht an. Wenn Sie diesen Parameter weglassen, verwendet Format-Custom die Standardansicht. Sie können den Property-Parameter nicht zusammen mit dem View-Parameter in einem Befehl verwenden.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die folgenden allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_Commonparameters.
Eingaben und Ausgaben
Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können. Der Rückgabetyp ist der Typ der Objekte, die das Cmdlet zurückgibt.
|
Eingaben |
System.Management.Automation.PSObject Sie können jedes Objekt über die Pipeline an Format-Custom übergeben. |
|
Ausgaben |
Microsoft.PowerShell.Commands.Internal.Format Format-Custom gibt die Formatobjekte zurück, die die Anzeige darstellen. |
Hinweise
Format-Custom ist für die Anzeige von Ansichten vorgesehen, bei denen es sich nicht lediglich um Tabellen oder Listen handelt. Um eine alternative Tabellenansicht anzuzeigen, verwenden Sie Format-Table. Um eine alternative Listenansicht anzuzeigen, verwenden Sie Format-List.
Sie können auch über den integrierten Alias "fc" auf Format-Custom verweisen. Weitere Informationen finden Sie unter "about_Aliases".
Für den GroupBy-Parameter wird vorausgesetzt, dass die Objekte sortiert sind. Bevor Sie die Objekte mit Format-Custom gruppieren, sortieren Sie sie mit Sort-Object.
Beispiel 1
C:\PS>get-command start-transcript | format-custom -view MyView Beschreibung ----------- Mit diesem Befehl werden Informationen über das Cmdlet "Start-Transcript" in dem Format formatiert, das durch die Ansicht "MyView" definiert ist. Dies ist eine benutzerdefinierte Ansicht, die vom Benutzer erstellt wird. Um den Befehl erfolgreich auszuführen, müssen Sie zunächst eine neue PS1XML-Datei erstellen, die Ansicht "MyView" definieren und anschließend Windows PowerShell mithilfe des Befehls "Update-FormatData" die PS1XML-Datei hinzufügen.
Beispiel 2
C:\PS>get-process Winlogon | format-custom Beschreibung ----------- Mit diesem Befehl werden Informationen über die Windows-Anmeldung in einer alternativen benutzerdefinierten Ansicht formatiert. Weil für den Befehl nicht der View-Parameter verwendet wird, formatiert Format-Custom die Daten mit der benutzerdefinierten Standardansicht.