Udostępnij za pośrednictwem

Format-Custom

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Używa dostosowanego widoku do formatowania danych wyjściowych.

Składnia

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 dotyczące cmdlet Start-Transcript w formacie określonym przez widok MyView, który jest niestandardowym 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.

Typ:Int32
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-DisplayError

Wyświetla błędy w wierszu polecenia. Ten parametr jest rzadko stosowany, jednak może służyć jako pomoc debugowania podczas formatowania wyrażeń w poleceniu Format-Custom, jeśli wyrażenia nie wydają się działać.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.
Typ:String
Dopuszczalne wartości:CoreOnly, EnumOnly, Both
Position:Named
Domyślna wartość:EnumOnly
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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 Format-Custom użyj polecenia cmdlet Sort-Object, 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-wartość to:

  • Nazwa (lub etykieta) <string>
  • Wyrażenie <string> lub <script block>
  • FormatString <string>

Aby uzyskać więcej informacji, zobacz about_Calculated_Properties.

Typ:Object
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.

Typ:PSObject
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-Property

Określa właściwości obiektu wyświetlane na ekranie i kolejność ich wyświetlania. Dozwolone są symbole wieloznaczne.

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. W tym samym poleceniu nie można użyć parametrów właściwości i View.

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-wartość to:

  • Wyrażenie — <string> lub <script block>
  • Głębokość — <int32>

Aby uzyskać więcej informacji, odnies się do about_Calculated_Properties.

Typ:Object[]
Position:0
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:True

-ShowError

Wysyła błędy przez szlak przetwarzania. Parametr ten jest rzadko używany, ale może być używany jako pomoc w debugowaniu podczas formatowania wyrażeń w Format-Custom w poleceniu, jeśli wyrażenia wydają się nie działać.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-View

Określa nazwę alternatywnego formatu lub widoku. Jeśli pominięto ten parametr, Format-Custom używa domyślnego widoku niestandardowego. W tym samym poleceniu nie można użyć parametrów właściwości oraz widoku .

Typ:String
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

Dane wejściowe

PSObject

Do tego polecenia cmdlet można przesyłać dowolne obiekty.

Dane wyjściowe

Microsoft.PowerShell.Commands.Internal.Format

To polecenie cmdlet zwraca obiekty formatu reprezentujące wyświetlacz.

Uwagi

Program Windows PowerShell zawiera następujące aliasy dla Format-Custom:

  • 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.