Format-Custom

  • Referens
Modul:
Microsoft.PowerShell.Utility

Använder en anpassad vy för att formatera utdata.

Syntax

Format-Custom
      [[-Property] <Object[]>]
      [-Depth <Int32>]
      [-GroupBy <Object>]
      [-View <String>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <String>]
      [-InputObject <PSObject>]
      [<CommonParameters>]

Description

Cmdleten Format-Custom formaterar utdata från ett kommando enligt definitionen i en alternativ vy. Format-Custom är utformad för att visa vyer som inte bara är tabeller eller bara listor. Du kan använda vyerna som definierats i PowerShell, eller så kan du skapa egna vyer i en ny format.ps1xml fil och använda cmdleten Update-FormatData för att lägga till dem i PowerShell.

Exempel

Exempel 1: Formatera utdata med en anpassad vy

Get-Command Start-Transcript | Format-Custom -View MyView

Det här kommandot formaterar information om cmdleten Start-Transcript i det format som definieras av MyView-vyn, en anpassad vy som skapats av användaren. Om du vill köra det här kommandot måste du först skapa en ny PS1XML-fil, definiera MyView-vyn och sedan använda Update-FormatData kommandot för att lägga till PS1XML-filen i PowerShell.

Exempel 2: Formatera utdata med standardvyn

Get-Process Winlogon | Format-Custom

Det här kommandot formaterar information om Winlogon-processen i en alternativ anpassad vy. Eftersom kommandot inte använder parametern Format-Custom Visa använder en anpassad standardvy för att formatera data.

Exempel 3: Felsöka formatfel

I följande exempel visas resultatet av att lägga till parametrarna DisplayError eller ShowError med ett uttryck.

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

Parametrar

-Depth

Anger antalet kolumner i visningen.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayError

Visar fel på kommandoraden. Den här parametern används sällan, men kan användas som felsökningshjälp när du formaterar uttryck i ett Format-Custom kommando och uttrycken inte verkar fungera.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expand

Formaterar samlingsobjektet samt objekten i samlingen. Den här parametern är utformad för att formatera objekt som stöder gränssnittet System.Collections.ICollection . Standardvärdet är EnumOnly.

Giltiga värden är:

  • EnumOnly: Visar egenskaperna för objekten i samlingen.
  • CoreOnly: Visar egenskaperna för samlingsobjektet.
  • Båda: Visar egenskaperna för samlingsobjektet och objekten i samlingen.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Dirigerar cmdleten till att visa all felinformation. Använd med parametrarna DisplayError eller ShowError . När ett felobjekt skrivs till fel- eller visningsströmmar visas som standard endast en del av felinformationen.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupBy

Formaterar utdata i grupper baserat på en delad egenskap eller ett delat värde. Ange ett uttryck eller en egenskap för utdata.

Värdet för parametern GroupBy kan vara en ny beräknad egenskap. Den beräknade egenskapen kan vara ett skriptblock eller en hash-tabell. Giltiga nyckel/värde-par är:

  • Namn (eller etikett) - <string>
  • Uttryck – <string> eller <script block>
  • FormatString - <string>

Mer information finns i about_Calculated_Properties.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Anger vilka objekt som ska formateras. Ange en variabel som innehåller objekten eller skriv ett kommando eller uttryck som hämtar objekten.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Property

Anger de objektegenskaper som visas i visningen och i vilken ordning de visas. Jokertecken tillåts.

Om du utelämnar den här parametern beror egenskaperna som visas i visningen på det objekt som visas. Parameternamnegenskapen är valfri. Du kan inte använda parametrarna Egenskap och Visa i samma kommando.

Värdet för egenskapsparametern kan vara en ny beräknad egenskap. Den beräknade egenskapen kan vara ett skriptblock eller en hash-tabell. Giltiga nyckel/värde-par är:

  • Uttryck – <string> eller <script block>
  • Djup- <int32>

Mer information finns i about_Calculated_Properties.

Type:Object[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

Skickar fel via pipelinen. Den här parametern används sällan, men kan användas som felsökningshjälp när du formaterar uttryck i ett Format-Custom kommando och uttrycken inte verkar fungera.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-View

Anger namnet på ett alternativt format eller en vy. Om du utelämnar den här parametern Format-Custom använder du en anpassad standardvy. Du kan inte använda parametrarna Egenskap och Visa i samma kommando.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Indata

PSObject

Du kan skicka valfritt objekt till den här cmdleten.

Utdata

Microsoft.PowerShell.Commands.Internal.Format

Den här cmdleten returnerar formatobjekten som representerar visningen.

Kommentarer

PowerShell innehåller följande alias för Format-Custom:

  • Alla plattformar:
    • fc

Format-Custom är utformad för att visa vyer som inte bara är tabeller eller bara listor. Om du vill visa en alternativ tabellvy använder du Format-Table. Om du vill visa en alternativ listvy använder du Format-List.

Parametern GroupBy förutsätter att objekten sorteras. Innan du använder Format-Custom för att gruppera objekten använder du Sort-Object för att sortera dem.