Format-Custom
Testre szabott nézetet használ a kimenet formázásához.
Syntax
Default (Alapértelmezett)
Format-Custom
[[-Property] <Object[]>]
[-Depth <Int32>]
[-GroupBy <Object>]
[-View <String>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <String>]
[-InputObject <PSObject>]
[<CommonParameters>]
Description
A Format-Custom parancsmag egy parancs kimenetét más nézetben definiálja.
Format-Custom olyan nézetek megjelenítésére szolgál, amelyek nem csak táblák vagy csak listák. Használhatja a PowerShellben definiált nézeteket, vagy létrehozhat saját nézeteket egy új format.ps1xml fájlban, és a Update-FormatData parancsmaggal felveheti őket a PowerShellbe.
Példák
1. példa: Kimenet formázása egyéni nézettel
Get-Command Start-Transcript | Format-Custom -View MyView
Ez a parancs a felhasználó által létrehozott egyéni nézet, a MyView nézet által meghatározott formátumban formázza a Start-Transcript parancsmag adatait. A parancs sikeres futtatásához először létre kell hoznia egy új PS1XML-fájlt, meg kell adnia a MyView nézetet, majd a Update-FormatData paranccsal hozzá kell adnia a PS1XML-fájlt a PowerShellhez.
2. példa: Kimenet formázása az alapértelmezett nézettel
Get-Process Winlogon | Format-Custom
Ez a parancs a Winlogon folyamat adatait formáz egy másik, testre szabott nézetben.
Mivel a parancs nem használja a View paramétert, Format-Custom az adatok formázásához alapértelmezett egyéni nézetet használ.
3. példa: Formátumhibák elhárítása
Az alábbi példák a DisplayError vagy ShowError paraméterek kifejezéssel való hozzáadásának eredményeit mutatják be.
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
Paraméterek
-Depth
A megjelenítendő oszlopok számát adja meg.
Paramétertulajdonságok
| Típus: | Int32 |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-DisplayError
Hibák megjelenítése a parancssorban. Ezt a paramétert ritkán használják, de hibakeresési segédként is használható, ha kifejezéseket formáz egy Format-Custom parancsban, és úgy tűnik, hogy a kifejezések nem működnek.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Expand
Formázja a gyűjteményobjektumot és a gyűjteményben lévő objektumokat. Ez a paraméter a System.Collections.ICollection interfészt támogató objektumok formázására szolgál. Az alapértelmezett érték az EnumOnly
Az érvényes értékek a következők:
- EnumOnly: Megjeleníti a gyűjtemény objektumainak tulajdonságait.
- CoreOnly: Megjeleníti a gyűjteményobjektum tulajdonságait.
- Mindkettő: Megjeleníti a gyűjteményobjektum és a gyűjtemény objektumainak tulajdonságait.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | EnumOnly |
| Elfogadott értékek: | CoreOnly, EnumOnly, Both |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Force
A parancsmagot az összes hibainformáció megjelenítésére irányítja. Használja a DisplayError vagy ShowError paraméterekkel. Alapértelmezés szerint, amikor egy hibaobjektumot írunk a hiba- vagy kijelzőfolyamokba, csak néhány hibainformáció jelenik meg.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-GroupBy
A kimenetet csoportokba formázhatja egy megosztott tulajdonság vagy érték alapján. Adja meg a kimenet kifejezését vagy tulajdonságát. A GroupBy paraméter az objektumok rendezésére számít. Használja a Sort-Object parancsmagot, mielőtt Format-Custom használva csoportosítja az objektumokat.
A GroupBy paraméter értéke új számított tulajdonság lehet. A számított tulajdonság lehet szkriptblokk vagy kivonattábla. Az érvényes kulcs-érték párok a következők:
- Név (vagy címke) –
<string> - Kifejezés –
<string>vagy<script block> - FormatString –
<string>
További információkért lásd a about_Calculated_Propertiesrészt.
Paramétertulajdonságok
| Típus: | Object |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-InputObject
Megadja a formázandó objektumokat. Adjon meg egy változót, amely tartalmazza az objektumokat, vagy írjon be egy parancsot vagy kifejezést, amely lekéri az objektumokat.
Paramétertulajdonságok
| Típus: | PSObject |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | True |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-Property
Megadja a megjelenítésben megjelenő objektumtulajdonságokat és azok megjelenési sorrendjét. Helyettesítő karakterek használata engedélyezett.
Ha kihagyja ezt a paramétert, a megjelenítésben megjelenő tulajdonságok a megjelenített objektumtól függenek. A paraméter neve tulajdonság nem kötelező. Nem használhatja ugyanabban a parancsban a tulajdonság és a View paramétereket.
A tulajdonság paraméter értéke új számított tulajdonság lehet. A számított tulajdonság lehet szkriptblokk vagy kivonattábla. Az érvényes kulcs-érték párok a következők:
- Kifejezés –
<string>vagy<script block> - Mélység –
<int32>
További információkért lásd a about_Calculated_Propertiesrészt.
Paramétertulajdonságok
| Típus: | Object[] |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | True |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | 0 |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-ShowError
Hibákat továbbít a csővezetéken keresztül. Ezt a paramétert ritkán használják, de hibakeresési segédként is használható, ha kifejezéseket formáz egy Format-Custom parancsban, és úgy tűnik, hogy a kifejezések nem működnek.
Paramétertulajdonságok
| Típus: | SwitchParameter |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
-View
Egy másik formátum vagy nézet nevét adja meg. Ha kihagyja ezt a paramétert, Format-Custom alapértelmezett egyéni nézetet használ. Nem használhatja ugyanabban a parancsban a tulajdonság és a View paramétereket.
Paramétertulajdonságok
| Típus: | String |
| Alapértelmezett érték: | None |
| Támogatja a helyettesítő karaktereket: | False |
| DontShow: | False |
Paraméterkészletek
(All)
| Position: | Named |
| Kötelező: | False |
| Folyamatból származó érték: | False |
| Folyamatból származó érték tulajdonságnév alapján: | False |
| Fennmaradó argumentumokból származó érték: | False |
CommonParameters
Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.
Bevitelek
PSObject
A parancsmaghoz bármilyen objektumot csövezhet.
Kimenetek
Microsoft.PowerShell.Commands.Internal.Format
Ez a parancsmag a megjelenítést jelképezendő formátumobjektumokat adja vissza.
Jegyzetek
A PowerShell a következő aliasokat tartalmazza Format-Custom:
- Minden platform:
fc
Format-Custom olyan nézetek megjelenítésére szolgál, amelyek nem csak táblák vagy csak listák. Másik táblázatnézet megjelenítéséhez használja a Format-Table. Alternatív listanézet megjelenítéséhez használja a Format-List.
A GroupBy paraméter feltételezi, hogy az objektumok rendezve vannak. Mielőtt Format-Custom használ az objektumok csoportosításához, a Sort-Object használatával rendezze őket.