Format-Custom
Używa dostosowanego widoku do formatowania danych wyjściowych.
Składnia
Default (Domyślna)
Format-Custom
[[-Property] <Object[]>]
[-Depth <Int32>]
[-GroupBy <Object>]
[-View <String>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <String>]
[-InputObject <PSObject>]
[<CommonParameters>]
Opis
Polecenie cmdlet Format-Custom formatuje dane wyjściowe polecenia zgodnie z definicją w widoku alternatywnym.
Format-Custom jest przeznaczony do wyświetlania widoków, które nie są tylko tabelami lub po prostu listami. Możesz użyć widoków zdefiniowanych w programie PowerShell lub utworzyć własne widoki w nowym pliku format.ps1xml i użyć polecenia cmdlet Update-FormatData, aby dodać je do programu PowerShell.
Przykłady
Przykład 1. Formatowanie danych wyjściowych za pomocą widoku niestandardowego
Get-Command Start-Transcript | Format-Custom -View MyView
To polecenie formatuje informacje o poleceniu cmdlet Start-Transcript w formacie zdefiniowanym przez widok MyView, który jest widokiem utworzonym przez użytkownika. Aby pomyślnie uruchomić to polecenie, należy najpierw utworzyć nowy plik PS1XML, zdefiniować widok MyView, a następnie użyć polecenia Update-FormatData, aby dodać plik PS1XML do programu PowerShell.
Przykład 2. Formatowanie danych wyjściowych przy użyciu widoku domyślnego
Get-Process Winlogon | Format-Custom
To polecenie formatuje informacje o procesie Winlogon w alternatywnym dostosowanym widoku.
Ponieważ polecenie nie używa parametru View, Format-Custom używa domyślnego widoku niestandardowego do formatowania danych.
Przykład 3. Rozwiązywanie problemów z błędami formatu
W poniższych przykładach pokazano wyniki dodawania parametrów DisplayError lub ShowError z wyrażeniem.
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
Parametry
-Depth
Określa liczbę kolumn na ekranie.
Właściwości parametru
| Typ: | Int32 |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-DisplayError
Wyświetla błędy w wierszu polecenia. Ten parametr jest rzadko używany, ale może być używany jako pomoc w debugowaniu podczas formatowania wyrażeń w poleceniu Format-Custom, jeżeli wyrażenia nie wydają się działać.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Expand
Formatuje obiekt kolekcji, a także obiekty w kolekcji. Ten parametr jest przeznaczony do formatowania obiektów obsługujących interfejs System.Collections.ICollection. Wartość domyślna to EnumOnly.
Prawidłowe wartości to:
- EnumOnly: wyświetla właściwości obiektów w kolekcji.
- CoreOnly: wyświetla właściwości obiektu kolekcji.
- Oba: wyświetla właściwości obiektu kolekcji i obiektów w kolekcji.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | EnumOnly |
| Dopuszczalne wartości: | CoreOnly, EnumOnly, Both |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Force
Przekierowuje polecenie cmdlet, aby wyświetlić wszystkie informacje o błędzie. Użyj z parametrami DisplayError lub ShowError. Domyślnie, gdy obiekt błędu jest zapisywany w strumieniach błędów lub strumieniach wyświetlania, wyświetlane są tylko niektóre informacje o błędzie.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-GroupBy
Formatuje dane wyjściowe w grupach na podstawie właściwości udostępnionej lub wartości. Wprowadź wyrażenie lub właściwość danych wyjściowych. Parametr GroupBy oczekuje sortowania obiektów. Przed użyciem Sort-Object użyj polecenia cmdlet Format-Custom, aby zgrupować obiekty.
Wartość parametru GroupBy może być nową właściwością obliczeniową. Właściwość obliczeniowa może być blokiem skryptu lub tabelą skrótów. Prawidłowe pary klucz i wartość to:
- Nazwa (lub etykieta) —
<string> - Wyrażenie —
<string>lub<script block> - FormatString —
<string>
Aby uzyskać więcej informacji, odnieś się do about_Calculated_Properties.
Właściwości parametru
| Typ: | Object |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-InputObject
Określa obiekty, które mają być sformatowane. Wprowadź zmienną zawierającą obiekty lub wpisz polecenie lub wyrażenie, które pobiera obiekty.
Właściwości parametru
| Typ: | PSObject |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | True |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Property
Określa właściwości obiektu wyświetlane na ekranie i kolejność ich wyświetlania. Symbole wieloznaczne są dozwolone.
Jeśli pominiesz ten parametr, właściwości wyświetlane na ekranie zależą od wyświetlanego obiektu. Nazwa parametru właściwość jest opcjonalna. Nie można użyć parametru właściwości i parametru widoku w tym samym poleceniu.
Wartość parametru Property może być nową właściwością obliczeniową. Właściwość obliczeniowa może być blokiem skryptu lub tabelą skrótów. Prawidłowe pary klucz i wartość to:
- Wyrażenie —
<string>lub<script block> - Głębokość —
<int32>
Aby uzyskać więcej informacji, odnieś się do about_Calculated_Properties.
Właściwości parametru
| Typ: | Object[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | 0 |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-ShowError
Wysyła błędy przez szlak przetwarzania. Ten parametr jest rzadko używany, ale może być używany jako pomoc w debugowaniu podczas formatowania wyrażeń w poleceniu Format-Custom, jeżeli wyrażenia nie wydają się działać.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-View
Określa nazwę alternatywnego formatu lub widoku. Jeśli pominięto ten parametr, Format-Custom używa domyślnego widoku niestandardowego. Nie można użyć parametru właściwości i parametru widoku w tym samym poleceniu.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.
Dane wejściowe
PSObject
Do tego polecenia cmdlet można przekierować dowolny obiekt.
Dane wyjściowe
Microsoft.PowerShell.Commands.Internal.Format
To polecenie cmdlet zwraca obiekty formatu reprezentujące wyświetlacz.
Uwagi
Program PowerShell zawiera następujące aliasy dla Format-Custom:
- Wszystkie platformy:
fc
Format-Custom jest przeznaczony do wyświetlania widoków, które nie są tylko tabelami lub po prostu listami. Aby wyświetlić widok tabeli alternatywnej, użyj Format-Table. Aby wyświetlić widok listy alternatywnej, użyj Format-List.
Parametr GroupBy zakłada, że obiekty są sortowane. Przed użyciem Format-Custom do grupowania obiektów użyj Sort-Object do ich sortowania.
