Format-Custom
K formátování výstupu se používá přizpůsobené zobrazení.
Syntax
Default (Výchozí)
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 cmdletu Start-Transcript ve formátu definovaném zobrazením MyView, což je vlastní pohled vytvořený 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, když jsou parametry DisplayError nebo ShowError přidány k výrazu.
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í.
Vlastnosti parametru
| Typ: | Int32 |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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í.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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.
Vlastnosti parametru
| Typ: | String |
| Default value: | EnumOnly |
| Přípustné hodnoty: | CoreOnly, EnumOnly, Both |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Force
Nasměruje cmdlet tak, aby zobrazil veškeré informace 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ě.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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> - Formátovací řetězec -
<string>
Další informace naleznete v dokumentaci about_Calculated_Properties.
Vlastnosti parametru
| Typ: | Object |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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á.
Vlastnosti parametru
| Typ: | PSObject |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | True |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Property
Určuje vlastnosti objektu, které se zobrazí v zobrazení, a pořadí, ve kterém se zobrazí. Jsou povoleny zástupné symboly.
Pokud tento parametr vynecháte, vlastnosti, které se zobrazí na displeji, závisí na zobrazeném objektu. Název parametru Vlastnost je nepovinný. Nelze použít parametry vlastnosti a zobrazení ve stejném příkazu.
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>
Další informace naleznete v dokumentaci about_Calculated_Properties.
Vlastnosti parametru
| Typ: | Object[] |
| Default value: | None |
| Podporuje zástupné znaky: | True |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 0 |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-ShowError
Odesílá chyby prostřednictvím potrubí. 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í.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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í. Nelze použít parametry vlastnosti a zobrazení ve stejném příkazu.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
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é. Než použijete Format-Custom k seskupení objektů, použijte Sort-Object k jejich seřazení.