Format-Custom
Maakt gebruik van een aangepaste weergave om de uitvoer op te maken.
Syntax
Format-Custom
[[-Property] <Object[]>]
[-Depth <Int32>]
[-GroupBy <Object>]
[-View <String>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <String>]
[-InputObject <PSObject>]
[<CommonParameters>]
Description
De Format-Custom
cmdlet formatteert de uitvoer van een opdracht zoals gedefinieerd in een alternatieve weergave.
Format-Custom
is ontworpen om weergaven weer te geven die niet alleen tabellen of lijsten zijn. U kunt de weergaven gebruiken die zijn gedefinieerd in PowerShell of u kunt uw eigen weergaven maken in een nieuw format.ps1xml
bestand en de Update-FormatData
cmdlet gebruiken om deze toe te voegen aan PowerShell.
Voorbeelden
Voorbeeld 1: Uitvoer opmaken met een aangepaste weergave
Get-Command Start-Transcript | Format-Custom -View MyView
Met deze opdracht wordt informatie over de Start-Transcript
cmdlet opgemaakt in de indeling die is gedefinieerd door de weergave MyView, een aangepaste weergave die door de gebruiker is gemaakt. Als u deze opdracht wilt uitvoeren, moet u eerst een nieuw PS1XML-bestand maken, de Weergave MyView definiƫren en vervolgens de Update-FormatData
opdracht gebruiken om het PS1XML-bestand toe te voegen aan PowerShell.
Voorbeeld 2: Uitvoer opmaken met de standaardweergave
Get-Process Winlogon | Format-Custom
Met deze opdracht wordt informatie over het Winlogon-proces opgemaakt in een alternatieve aangepaste weergave.
Omdat de opdracht geen gebruik maakt van de parameter Weergave , Format-Custom
wordt een standaard aangepaste weergave gebruikt om de gegevens op te maken.
Voorbeeld 3: Opmaakfouten oplossen
In de volgende voorbeelden ziet u de resultaten van het toevoegen van de parameters DisplayError of ShowError met een expressie.
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
Parameters
-Depth
Hiermee geeft u het aantal kolommen in de weergave.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DisplayError
Geeft fouten weer op de opdrachtregel. Deze parameter wordt zelden gebruikt, maar kan worden gebruikt als een hulpmiddel voor foutopsporing wanneer u expressies opmaakt in een Format-Custom
opdracht en de expressies lijken niet te werken.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Expand
Hiermee wordt het verzamelingsobject en de objecten in de verzameling opgemaakt. Deze parameter is ontworpen om objecten op te maken die ondersteuning bieden voor de interface System.Collections.ICollection . De standaardwaarde is EnumOnly.
Geldige waarden zijn:
- EnumOnly: geeft de eigenschappen weer van de objecten in de verzameling.
- CoreOnly: geeft de eigenschappen van het verzamelingsobject weer.
- Beide: geeft de eigenschappen van het verzamelingsobject en de objecten in de verzameling weer.
Type: | String |
Accepted values: | CoreOnly, EnumOnly, Both |
Position: | Named |
Default value: | EnumOnly |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Hiermee geeft u de cmdlet om alle foutinformatie weer te geven. Te gebruiken met de parameters DisplayError of ShowError . Wanneer een foutobject naar de fout- of weergavestreams wordt geschreven, wordt standaard slechts een deel van de foutinformatie weergegeven.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-GroupBy
Hiermee wordt de uitvoer in groepen opgemaakt op basis van een gedeelde eigenschap of waarde. Voer een expressie of een eigenschap van de uitvoer in.
De waarde van de parameter GroupBy kan een nieuwe berekende eigenschap zijn. De berekende eigenschap kan een scriptblok of een hash-tabel zijn. Geldige sleutel-waardeparen zijn:
- Naam (of label) -
<string>
- Expressie -
<string>
of<script block>
- FormatString -
<string>
Zie about_Calculated_Properties voor meer informatie.
Type: | Object |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Hiermee geeft u de objecten op die moeten worden opgemaakt. Voer een variabele in die de objecten bevat of typ een opdracht of expressie waarmee de objecten worden opgehaald.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Property
Hiermee geeft u de objecteigenschappen die worden weergegeven in de weergave en de volgorde waarin ze worden weergegeven. Jokertekens zijn toegestaan.
Als u deze parameter weglaat, zijn de eigenschappen die in de weergave worden weergegeven afhankelijk van het object dat wordt weergegeven. De parameternaam Eigenschap is optioneel. U kunt de parameters Eigenschap en Weergave niet in dezelfde opdracht gebruiken.
De waarde van de parameter Eigenschap kan een nieuwe berekende eigenschap zijn. De berekende eigenschap kan een scriptblok of een hash-tabel zijn. Geldige sleutel-waardeparen zijn:
- Expressie -
<string>
of<script block>
- Diepte-
<int32>
Zie about_Calculated_Properties voor meer informatie.
Type: | Object[] |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-ShowError
Verzendt fouten via de pijplijn. Deze parameter wordt zelden gebruikt, maar kan worden gebruikt als een hulpmiddel voor foutopsporing wanneer u expressies opmaakt in een Format-Custom
opdracht en de expressies lijken niet te werken.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-View
Hiermee geeft u de naam van een alternatieve indeling of weergave. Als u deze parameter weglaat, Format-Custom
wordt een standaard aangepaste weergave gebruikt. U kunt de parameters Eigenschap en Weergave niet in dezelfde opdracht gebruiken.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Invoerwaarden
U kunt elk object doorsnijden naar deze cmdlet.
Uitvoerwaarden
Microsoft.PowerShell.Commands.Internal.Format
Deze cmdlet retourneert de indelingsobjecten die de weergave vertegenwoordigen.
Notities
PowerShell bevat de volgende aliassen voor Format-Custom
:
- Alle platformen:
fc
Format-Custom
is ontworpen om weergaven weer te geven die niet alleen tabellen of lijsten zijn. Als u een alternatieve tabelweergave wilt weergeven, gebruikt u Format-Table
. Als u een alternatieve lijstweergave wilt weergeven, gebruikt u Format-List
.
Bij de parameter GroupBy wordt ervan uitgegaan dat de objecten zijn gesorteerd. Voordat u Format-Custom
de objecten gaat groeperen, gebruikt Sort-Object
u om ze te sorteren.