Sdílet prostřednictvím

Format-List

Modul:
Microsoft.PowerShell.Utility Module

Formátuje výstup jako seznam vlastností, ve kterých se každá vlastnost zobrazuje na novém řádku.

Syntaxe

Default (Výchozí) 

Format-List
    [[-Property] <Object[]>]
    [-GroupBy <Object>]
    [-View <string>]
    [-ShowError]
    [-DisplayError]
    [-Force]
    [-Expand <string>]
    [-InputObject <psobject>]
    [<CommonParameters>]

Description

Rutina Format-List formátuje výstup příkazu jako seznam vlastností, ve kterých se každá vlastnost zobrazí na samostatném řádku. Pomocí Format-List můžete formátovat a zobrazit všechny nebo vybrané vlastnosti objektu jako seznam (Format-List -Property *).

Vzhledem k tomu, že pro každou položku v seznamu je k dispozici více místa než v tabulce, PowerShell zobrazí více vlastností objektu v seznamu a hodnoty vlastností budou méně pravděpodobné, že budou zkráceny.

Příklady

Příklad 1: Formátování počítačových služeb

Get-Service | Format-List

Tento příkaz formátuje informace o službách v počítači jako seznam. Ve výchozím nastavení jsou služby formátované jako tabulka. Příkaz Get-Service získá objekty představující služby v počítači. Operátor kanálu (|) předává výsledky prostřednictvím kanálu do Format-List. Potom Format-List příkaz naformátuje informace o službě v seznamu a odešle je do výchozí výstupní rutiny pro zobrazení.

Příklad 2: Formátování souborů PS1XML

Tyto příkazy zobrazují informace o souborech PS1XML v adresáři PowerShellu jako seznam.

$A = Get-ChildItem $PSHOME\*.ps1xml
Format-List -InputObject $A

První příkaz získá objekty představující soubory a uloží je do $A proměnné.

Druhý příkaz používá Format-List k formátování informací o objektech uložených v $A. Tento příkaz pomocí parametru InputObject předá proměnnou Format-List, která pak odešle formátovaný výstup do výchozí výstupní rutiny pro zobrazení.

Příklad 3: Formátování vlastností procesu podle názvu

Tento příkaz zobrazí název, základní prioritu a třídu priority každého procesu v počítači.

Get-Process | Format-List -Property Name, BasePriority, PriorityClass

Pomocí rutiny Get-Process získá objekt představující jednotlivé procesy. Operátor potrubí (|) předá objekty procesu prostřednictvím potrubí do Format-List. Format-List procesy formátuje jako seznam zadaných vlastností. Název parametru vlastnost je volitelný, takže ho můžete vynechat.

Příklad 4: Formátování všech vlastností procesu

Tento příkaz zobrazí všechny vlastnosti procesu Winlogon.

Get-Process winlogon | Format-List -Property *

Používá rutinu Get-Process k získání objektu představujícího proces Winlogon. Operátor potrubí (|) předá objekt procesu Winlogon prostřednictvím potrubí do Format-List. Příkaz pomocí parametru Property určuje vlastnosti a * k označení všech vlastností. Protože název parametru Vlastnost je volitelný, můžete ho vynechat a zadat příkaz jako Format-List *. Format-List výsledky automaticky odešle do výchozí výstupní rutiny pro zobrazení.

Příklad 5: Ř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-List DayOfWeek, { $_ / $null } -DisplayError

DayOfWeek    : Friday
 $_ / $null  : #ERR

PC /> Get-Date | Format-List DayOfWeek, { $_ / $null } -ShowError

DayOfWeek    : Friday
 $_ / $null  :

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 7:59:23 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Parametry

-DisplayError

Označuje, že tato rutina zobrazuje 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-List 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

Určuje formátovaný objekt kolekce a také objekty v kolekci. Tento parametr je navržen pro formátování objektů, které podporují rozhraní System.Collections.ICollection. Výchozí hodnota je EnumOnly. Přijatelné hodnoty pro tento parametr jsou:

  • EnumOnly. Zobrazí vlastnosti objektů v kolekci.
  • CoreOnly. Zobrazí vlastnosti objektu kolekce.
  • Both. Zobrazí vlastnosti objektu kolekce a vlastnosti objektů v kolekci.

Vlastnosti parametru

Typ:String
Default value:None
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

Označuje, že tato rutina zobrazí všechny informace o chybě. Použijte s parametrem 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ě.

Vyžaduje se také při formátování určitých typů .NET. Další informace najdete v části Poznámky.

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

Určuje 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 Sort-Object použijte rutinu Format-List 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:

  • Name (nebo Label) – <string>
  • Expression - <string> nebo <script block>
  • FormatString - <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:

  • Name (nebo Label) – <string>
  • Expression - <string> nebo <script block>
  • FormatString - <string>

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

Označuje, že cmdlet 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-List 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í seznamu. 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í seznam.

Poznámky

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

  • Všechny platformy:
    • fl

Rutiny formátu, například Format-List, uspořádávají data, která se mají zobrazit, ale nezobrazují je. Data se zobrazují výstupními funkcemi PowerShellu a rutinami, které obsahují příkaz Out (rutiny Out), například Out-Host nebo Out-File.

Pokud nepoužíváte rutinu formátu, Použije PowerShell tento výchozí formát pro každý zobrazený objekt.

Parametr View umožňuje zadat alternativní formát tabulky. Můžete použít zobrazení definovaná v *.format.ps1xml souborech v adresáři PowerShellu nebo můžete vytvořit vlastní zobrazení v nových souborech PS1XML a pomocí rutiny Update-FormatData je zahrnout do PowerShellu.

Alternativní zobrazení parametru View musí používat formát seznamu, jinak příkaz selže. Pokud je alternativním zobrazením tabulka, použijte Format-Table. Pokud alternativní zobrazení není seznam nebo tabulka, použijte Format-Custom.

Pokud chcete použít Format-List s parametrem Vlastnost, musíte za některé z následujících podmínek zahrnout parametr Force: