Dela via

Format-Custom

Modul:
Microsoft.PowerShell.Utility Module

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

Syntax

Default (Standard) 

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 utformat 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 vyn MyView och sedan använda kommandot Update-FormatData 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- process i en alternativ anpassad vy. Eftersom kommandot inte använder parametern View använder Format-Custom en anpassad standardvy för att formatera data.

Exempel 3: Felsöka formatfel

Följande exempel visar 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.

Parameteregenskaper

Typ:Int32
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument: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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Expand

Formaterar samlingsobjektet samt objekten i samlingen. Den här parametern är utformad för att formatera objekt som stöder System.Collections.ICollection-gränssnittet. 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.

Parameteregenskaper

Typ:String
Standardvärde:EnumOnly
Godkända värden:CoreOnly, EnumOnly, Both
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument: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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument: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. Parametern GroupBy förväntar sig att objekten sorteras. Använd cmdleten Sort-Object innan du använder Format-Custom för att gruppera objekten.

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.

Parameteregenskaper

Typ:Object
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument: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.

Parameteregenskaper

Typ:PSObject
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument: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. Parameternamnet egenskap är valfritt. Du kan inte använda parametrarna Property och View i samma kommando.

Värdet för parametern Property 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.

Parameteregenskaper

Typ:

Object[]

Standardvärde:None
Stöder jokertecken:True
DontShow:False

Parameteruppsättningar

(All)
Position:0
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ShowError

Skickar fel genom processflödet. 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.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-View

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

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 utformat 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.