Sdílet prostřednictvím

Format-Custom

  • Reference
Modul:
Microsoft.PowerShell.Utility

K formátování výstupu se používá přizpůsobené zobrazení.

Syntaxe

Format-Custom
      [[-Property] <Object[]>]
      [-Depth <Int32>]
      [-GroupBy <Object>]
      [-View <String>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <String>]
      [-InputObject <PSObject>]
      [<CommonParameters>]

Description

Rutina Format-Custom formátuje výstup příkazu podle definice v alternativním zobrazení. Format-Custom je navržená tak, aby zobrazovala zobrazení, která nejsou jenom tabulkami nebo jenom seznamy. Můžete použít zobrazení definovaná v PowerShellu nebo můžete vytvořit vlastní zobrazení v novém souboru format.ps1xml a pomocí rutiny Update-FormatData je přidat do PowerShellu.

Příklady

Příklad 1: Formátování výstupu pomocí vlastního zobrazení

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

Tento příkaz formátuje informace o příkazu cmdlet Start-Transcript ve formátu definovaném zobrazením MyView, uživatelsky definovaným zobrazením vytvořeným uživatelem. Chcete-li tento příkaz úspěšně spustit, musíte nejprve vytvořit nový soubor PS1XML, definovat MyView zobrazení a potom pomocí příkazu Update-FormatData přidat soubor PS1XML do PowerShellu.

Příklad 2: Formátování výstupu s výchozím zobrazením

Get-Process Winlogon | Format-Custom

Tento příkaz formátuje informace o procesu Winlogon v alternativním přizpůsobeném zobrazení. Protože příkaz nepoužívá parametr View, Format-Custom k formátování dat používá výchozí vlastní zobrazení.

Příklad 3: Řešení chyb formátu

Následující příklady ukazují výsledky přidání parametrů DisplayError nebo ShowError s výrazem.

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

Určuje počet sloupců v zobrazení.

Typ:Int32
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-DisplayError

Zobrazí chyby na příkazovém řádku. Tento parametr se používá zřídka, ale lze ho použít jako pomůcku při ladění, když formátujete výrazy v příkazu Format-Custom a zdá se, že výrazy nefungují.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Expand

Formátuje objekt kolekce i objekty v kolekci. Tento parametr je navržen pro formátování objektů, které podporují rozhraní System.Collections.ICollection. Výchozí hodnota je EnumOnly.

Platné hodnoty jsou:

  • EnumOnly: Zobrazí vlastnosti objektů v kolekci.
  • CoreOnly: Zobrazí vlastnosti objektu kolekce.
  • Obojí: Zobrazí vlastnosti objektu kolekce a objekty v kolekci.
Typ:String
Přípustné hodnoty:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Force

Nasměruje cmdlet k zobrazení veškerých informací o chybě. Používá se s parametry DisplayError nebo ShowError. Ve výchozím nastavení se při zápisu objektu chyby do chybového nebo zobrazovacího datového proudu zobrazí pouze některé informace o chybě.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-GroupBy

Formátuje výstup ve skupinách na základě sdílené vlastnosti nebo hodnoty. Zadejte výraz nebo vlastnost výstupu. Parametr GroupBy očekává, že se objekty seřadí. Před použitím Format-Custom použijte rutinu Sort-Object k seskupení objektů.

Hodnota parametru GroupBy může být nová počítaná vlastnost. Počítaná vlastnost může být blok skriptu nebo tabulka hash. Platné páry klíč-hodnota jsou:

  • Název (nebo popisek) – <string>
  • Výraz – <string> nebo <script block>
  • Formátovací řetězec - <string>

Další informace naleznete v dokumentaci about_Calculated_Properties.

Typ:Object
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-InputObject

Určuje objekty, které mají být formátovány. Zadejte proměnnou obsahující objekty nebo zadejte příkaz nebo výraz, který objekty získá.

Typ:PSObject
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Property

Určuje vlastnosti objektu, které se zobrazí v zobrazení, a pořadí, ve kterém se zobrazí. Jsou povoleny zástupné cardy.

Pokud tento parametr vynecháte, vlastnosti, které se zobrazí na displeji, závisí na zobrazeném objektu. Název parametru Vlastnost je nepovinný. Ve stejném příkazu nelze použít parametry vlastnosti a zobrazení.

Hodnota parametru Vlastnost může být nově vypočítaná vlastnost. Počítaná vlastnost může být blok skriptu nebo tabulka hash. Platné páry klíč-hodnota jsou:

  • Výraz – <string> nebo <script block>
  • Hloubka – <int32>

Pro více informací si přečtěte about_Calculated_Properties.

Typ:Object[]
Position:0
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:True

-ShowError

Odesílá chyby prostřednictvím potrubí. Tento parametr se zřídka využívá, ale lze ho použít jako pomůcku pro ladění při formátování výrazů v příkazu Format-Custom, pokud se zdá, že výrazy nefungují dle očekávání.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-View

Určuje název alternativního formátu nebo zobrazení. Pokud tento parametr vynecháte, Format-Custom použije výchozí vlastní zobrazení. Ve stejném příkazu nelze použít parametry vlastnosti a Zobrazit.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

PSObject

K tomuto cmdletu můžete přesměrovat libovolný objekt.

Výstupy

Microsoft.PowerShell.Commands.Internal.Format

Tato rutina vrátí objekty formátu, které představují zobrazení.

Poznámky

PowerShell obsahuje následující aliasy pro Format-Custom:

  • Všechny platformy:
    • fc

Format-Custom je navržená tak, aby zobrazovala zobrazení, která nejsou jenom tabulkami nebo jenom seznamy. Pokud chcete zobrazit alternativní zobrazení tabulky, použijte Format-Table. Chcete-li zobrazit alternativní zobrazení seznamu, použijte Format-List.

Parametr GroupBy předpokládá, že objekty jsou seřazené. Před seskupením objektů pomocí Format-Custom je nejprve seřaďte pomocí Sort-Object.