Delen via

Format-Custom

Module:
Microsoft.PowerShell.Utility Module

Gebruikt een aangepaste weergave voor het formatteren van de output.

Syntaxis

Default (Standaard) 

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 alleen 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 ze 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 MyView-weergave, een aangepaste weergave die door de gebruiker gemaakt is. Als u deze opdracht wilt uitvoeren, moet u eerst een nieuw PS1XML-bestand maken, de weergave MyView definiëren en vervolgens de opdracht Update-FormatData 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 niet de parameter View gebruikt, gebruikt Format-Custom een standaard aangepaste weergave om de gegevens op te maken.

Voorbeeld 3: Opmaakfouten oplossen

In de volgende voorbeelden ziet u de resultaten van het toevoegen van de DisplayError- of ShowError parameters 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.

Parametereigenschappen

Type:Int32
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-DisplayError

Toont fouten op de opdrachtregel. Deze parameter wordt zelden gebruikt, maar kan worden gebruikt als foutopsporingshulpmiddel wanneer u expressies in een Format-Custom opdracht opmaakt en de expressies niet werken.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Expand

Formatteert het verzamelingsobject en de objecten in de verzameling. Deze parameter is ontworpen om objecten op te maken die ondersteuning bieden voor de System.Collections.ICollection interface. De standaardwaarde is EnumOnly-.

Geldige waarden zijn:

  • EnumOnly: Geeft de eigenschappen van de objecten in de verzameling weer.
  • CoreOnly: Geeft de eigenschappen van het verzamelingsobject weer.
  • Beide: Geeft de eigenschappen van het verzamelingsobject en de objecten in de verzameling weer.

Parametereigenschappen

Type:String
Default value:EnumOnly
Geaccepteerde waarden:CoreOnly, EnumOnly, Both
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Force

Zorgt ervoor dat de cmdlet alle foutinformatie weergeeft. Gebruik met de parameters DisplayError of ShowError. Wanneer een foutobject standaard naar de fout- of weergavestreams wordt geschreven, wordt slechts een deel van de foutgegevens weergegeven.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten: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 parameter GroupBy verwacht dat de objecten zijn gesorteerd. Gebruik de cmdlet Sort-Object voordat u Format-Custom gebruikt om de objecten te groeperen.

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_Propertiesvoor meer informatie.

Parametereigenschappen

Type:Object
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-InputObject

Specificeert de objecten die opgemaakt moeten worden. Voer een variabele in die de objecten bevat of typ een opdracht of expressie waarmee de objecten worden opgehaald.

Parametereigenschappen

Type:PSObject
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Property

Hiermee geeft u de objecteigenschappen op die worden weergegeven in de weergave en de volgorde waarin ze worden weergegeven. Wildcards 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 Property en de View parameters 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_Propertiesvoor meer informatie.

Parametereigenschappen

Type:

Object[]

Default value:None
Ondersteunt jokertekens:True
DontShow:False

Parametersets

(All)
Position:0
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ShowError

Verzendt fouten door de pijplijn. Deze parameter wordt zelden gebruikt, maar kan worden gebruikt als foutopsporingshulpmiddel wanneer u expressies in een Format-Custom opdracht opmaakt en de expressies niet werken.

Parametereigenschappen

Type:SwitchParameter
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-View

Hiermee geeft u de naam van een alternatieve indeling of weergave. Als u deze parameter weglaat, gebruikt Format-Custom een standaard aangepaste weergave. U kunt de Property en de View parameters niet in dezelfde opdracht gebruiken.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

PSObject

U kunt elk object doorsluisen naar deze cmdlet.

Uitvoerwaarden

Microsoft.PowerShell.Commands.Internal.Format

Met deze cmdlet worden de indelingsobjecten geretourneerd die de weergave vertegenwoordigen.

Notities

PowerShell bevat de volgende aliassen voor Format-Custom:

  • Alle platforms:
    • fc

Format-Custom is ontworpen om weergaven weer te geven die niet alleen tabellen of alleen 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 gebruikt om de objecten te groeperen, gebruikt u Sort-Object om ze te sorteren.