Format-Custom

  • Reference
Modul:
Microsoft.PowerShell.Utility

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

Syntax

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, jak je definováno v alternativním zobrazení. Format-Custom je navržený tak, aby zobrazoval 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 format.ps1xml souboru a pomocí rutiny je přidat do PowerShellu Update-FormatData .

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 Start-Transcript rutině ve formátu definovaném zobrazením MyView, vlastní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 zobrazení MyView a pak pomocí Update-FormatData příkazu 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í. Vzhledem k tomu, že příkaz nepoužívá parametr View , Format-Custom používá k formátování dat 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í.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayError

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expand

Formátuje objekt kolekce i objekty v kolekci. Tento parametr je navržen pro formátování objektů, které podporují System.Collections.ICollection rozhraní. 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.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Nasměruje rutinu tak, aby zobrazovala všechny informace o chybě. Používá se s parametry DisplayError nebo ShowError. Ve výchozím nastavení se při zápisu objektu chyby do chyby nebo zobrazení datových proudů zobrazí pouze některé informace o chybě.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupBy

Formátuje výstup ve skupinách na základě sdílené vlastnosti nebo hodnoty. Zadejte výraz nebo vlastnost výstupu.

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>
  • Formatstring- <string>

Další informace najdete v tématu about_Calculated_Properties.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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á.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters: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. Vlastnost názvu parametru je volitelná. Ve stejném příkazu nelze použít parametry vlastnosti a zobrazení .

Hodnota parametru Property 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:

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

Další informace najdete v tématu about_Calculated_Properties.

Type:Object[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

Odesílá chyby prostřednictvím kanálu. Tento parametr se používá zřídka, ale lze jej použít jako pomůcku ladění při formátování výrazů v Format-Custom příkazu a výrazy se zdá, že nefungují.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-View

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

PSObject

Do této rutiny můžete převést 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 zobrazoval zobrazení, která nejsou jenom tabulkami nebo jenom seznamy. Chcete-li 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řazeny. Před použitím Format-Custom k seskupení objektů je použijte Sort-Object k jejich seřazení.